Package com.highdeal.hci

Class SearchUserOperationOp

java.lang.Object
com.highdeal.hci.MessageOperationAdapter
com.highdeal.hci.SearchUserOperationOp
All Implemented Interfaces:
IXMLMarshallable, MessageOperation, XMLMarshallable
public class SearchUserOperationOp extends MessageOperationAdapter
This operation allows you to retrieve user operations using a specialized search filter.

Operation Result

SearchUserOperationResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchUserOperation">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="userOperationSearchFilter" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML tag of the operation: "searchUserOperation"
      See Also:

  • Constructor Details

    • SearchUserOperationOp

      public SearchUserOperationOp()
      Creates an empty search operation.

  • Method Details

    • getSearchFilter

      public UserOperationSearchFilterModel getSearchFilter()
      Gets the user operation search filter to use in the search.
      Returns:
      The user operation search filter to use in the search

    • setSearchFilter

      public void setSearchFilter(UserOperationSearchFilterModel searchFilter)
      Sets the user operation search filter to use in the search.
      Parameters:
      searchFilter - The user operation search filter to use in the search

    • 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

    • 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

    • 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

    • 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