com.highdeal.admin.hci
Class SearchRoleOp

java.lang.Object
  com.highdeal.hci.MessageOperationAdapter
      com.highdeal.admin.hci.SearchRoleOp

All Implemented Interfaces:

IXMLMarshallable, MessageOperation, XMLMapping, XMLMarshallable

public class SearchRoleOp
extends MessageOperationAdapter
implements XMLMapping

This operation allows searching for a role.

It is composed of an search filter including the wanted Role search criteria.
Send to the system, it retrieves the Roles corresponding to the criteria.

Result searchRoleResult

Operation Result

SearchRoleResult

Operation Failure Exception

InvalidSearchException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchRole">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="roleSearchFilter" type="RoleSearchFilterType" 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

Field Summary

static java.lang.String

OPERATION_NAME The XML tag name of the operation request: "searchRole"

Constructor Summary

SearchRoleOp()

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.Class<?>	getClass(java.lang.String nsUri, java.lang.String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
RoleSearchFilterModel	getFilter() Gets the search filter including the wanted Role search criteria.
java.lang.String	getName() Gets the XML name of the service operation.
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	setFilter(RoleSearchFilterModel filter) Sets the search filter including the wanted Role search criteria.

Methods inherited from class com.highdeal.hci.MessageOperationAdapter

marshal

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name of the operation request: "searchRole"

See Also:

Constant Field Values

Constructor Detail

SearchRoleOp

public SearchRoleOp()

Method Detail

getFilter

public RoleSearchFilterModel getFilter()

Gets the search filter including the wanted Role search criteria.

Returns:

The search filter including the wanted Role search criteria

setFilter

public void setFilter(RoleSearchFilterModel filter)

Sets the search filter including the wanted Role search criteria.

Parameters:

filter - The search filter including the wanted Role search criteria

getName

public java.lang.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

Specified by:

getName in interface MessageOperation

Returns:

The technical name of the HCI operation

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

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.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

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

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Specified by:

marshalAttributes in interface IXMLMarshallable

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.

Specified by:

marshalChildren in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the child objects into

getClass

public java.lang.Class<?> getClass(java.lang.String nsUri,
                                   java.lang.String tag,
                                   XMLAttributes atts)

Description copied from interface: XMLMapping

Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:

getClass in interface XMLMapping

Parameters:

nsUri - The unique resource identifier of the namespace of the XML tag

tag - The local part of the XML tag

atts - The attributes of the XML tag

Returns:

A Java class with a default constructor