com.highdeal.admin.hci

Class CreateRoleOp

java.lang.Object

com.highdeal.hci.MessageOperationAdapter

com.highdeal.admin.hci.CreateRoleOp

All Implemented Interfaces:

IXMLMarshallable, MessageOperation, XMLMarshallable

public class CreateRoleOp
extends MessageOperationAdapter

FOR INTERNAL USE ONLY - This operation allows you to create a role that can be assigned to the SAP CC users.

Operation Result

CreateRoleResult

Operation Failure Exceptions

• InvalidCreationException
• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="createRole">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="role" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
  </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

Audit Domain

This operation is audited as part of the audit domain ADMINISTRATION

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME The XML tag name of the operation: "createRole"

Constructor Summary

Constructors

Constructor and Description
CreateRoleOp()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getName() Gets the XML name of the service operation.
RoleModel	getRole() Gets the role to create.
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	setRole(RoleModel role) Sets the role to create.

Methods inherited from class com.highdeal.hci.MessageOperationAdapter

marshal

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name of the operation: "createRole"

See Also:

Constant Field Values

Constructor Detail

CreateRoleOp

public CreateRoleOp()

Method Detail

getRole

public RoleModel getRole()

Gets the role to create.

Returns:

The role to create

setRole

public void setRole(RoleModel role)

Sets the role to create.

Parameters:

role - The role to create

getName

public String getName()

Description copied from interface: MessageOperation

Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

Example

• activateAll
• ping

Returns:

The technical name of the HCI operation

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(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(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