Package com.highdeal.rangetable.hci

Class SearchSubscriberRangeTableOp

java.lang.Object
com.highdeal.hci.MessageOperationAdapter
com.highdeal.rangetable.hci.SearchSubscriberRangeTableOp
All Implemented Interfaces:
IXMLMarshallable, MessageOperation, XMLMapping, XMLMarshallable
public class SearchSubscriberRangeTableOp extends MessageOperationAdapter implements XMLMapping
This operation allows you to search for a subscriber range table in customer master data.

Send to the SAP CC system, it searches a Subscriber Range Table.
It is composed of the filter used to perform the search (only Subscriber Range Table that matches with this filter are returned). You can use the attribute rangeSetResult to get the subscriber range tables represented with range sets instead of rows in the result.

Operation Result

SearchSubscriberRangeTableResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchSubscriberRangeTable">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="subscriberRangeTableSearchFilter" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
    <xs:attribute name="rangeSetResult" type="xs:boolean" use="optional" default="false" />
  </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:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeNoNoNoNoNoNo

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML tag name of this service operation: "searchSubscriberRangeTable"
      See Also:

  • Constructor Details

    • SearchSubscriberRangeTableOp

      public SearchSubscriberRangeTableOp()

  • Method Details

    • getFilter

      public SubscriberRangeTableSearchFilterModel getFilter()
      Gets the filter used for the Subscriber Range Table search.
      Returns:
      The filter used during the search operation of the Subscriber Range Table

    • setFilter

      public void setFilter(SubscriberRangeTableSearchFilterModel filter)
      Sets the filter used by the search subscriber range table operation.
      Parameters:
      filter - The filter used to search a subscriber range table

    • isRangeSetResult

      public boolean isRangeSetResult()
      Returns true if the range table content must be returned as range sets, false if it must be returned as rows.
      Returns:
      true if the range table content must be returned as range sets, false if it must be returned as rows

    • setRangeSetResult

      public void setRangeSetResult(boolean rangeSetResult)
      Sets if the content of range table must be returned as range sets (true) or as rows (false).
      Parameters:
      rangeSetResult - true if the content of range table must be returned as range sets, false if it must be returned as rows

    • 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
      Specified by:
      getName in interface MessageOperation
      Returns:
      The technical name of the HCI operation

    • getClass

      public Class<?> getClass(String nsUri, 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

    • 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

    • 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.
      Specified by:
      addChild in interface XMLMarshallable
      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.
      Specified by:
      addCharacterData in interface XMLMarshallable
      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.
      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