com.highdeal.admin.hci
Class CreateRoleResult

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.hci.OperationResultAdapter
          com.highdeal.admin.hci.CreateRoleResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable

public class CreateRoleResult
extends OperationResultAdapter

FOR INTERNAL USE ONLY - This class represents the result of the Create Role operation; It contains the identifier of the new role.

Operation Request

CreateRoleOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="createRoleResult">
   <xs:complexType>
     <xs:attribute name="roleId" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	No	No	No	No	No

Field Summary

static java.lang.String

RESULT_NAME The value of that constant is the XML tag name of the result of creation of role: "createRoleResult"

Constructor Summary

CreateRoleResult()

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
java.lang.String	getRoleId() Gets the identifier of the role that has been created
java.lang.String	getTagName() Gets the XML tag name of the HCI operation result.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setRoleId(java.lang.String roleId) Sets the identifier of the role that has been created

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.highdeal.hci.XMLMarshallable

marshal

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME

The value of that constant is the XML tag name of the result of creation of role: "createRoleResult"

See Also:

Constant Field Values

Constructor Detail

CreateRoleResult

public CreateRoleResult()

Method Detail

getRoleId

public java.lang.String getRoleId()

Gets the identifier of the role that has been created

Returns:

The identifier of the new role

setRoleId

public void setRoleId(java.lang.String roleId)

Sets the identifier of the role that has been created

Parameters:

roleId - The identifier of the new role

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Returns:

The operand reference of the operation result

getTagName

public java.lang.String getTagName()

Description copied from class: OperationResultAdapter

Gets the XML tag name of the HCI operation result.

Specified by:

getTagName in interface ITagNameProvider

Specified by:

getTagName in class OperationResultAdapter

Returns:

The XML tag name

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into