Class SearchSubscriptionFromAccessOp

java.lang.Object
com.highdeal.pnr.hci.SearchSubscriptionFromAccessOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable

public class SearchSubscriptionFromAccessOp extends Object implements MessageOperation
This operation allows retrieving any subscription from an access selection by using a AccessSearchFilterModel to build search criterias. As the accesses count can be very high, we recommend to specify the complete userServiceId for avoiding to receive too much subscriptions.
As the user knows, the accesses are not attached directely to subscriptions but refers an activation charge which belongs to a subscription. As the subscription can be imbricated into an other one an so on, the returned subscription is not the inner one but the root one. So, the root subscription will be exported with its all nested subscriptions and their activation charges. In fact, the caller may receive the complete root subscription hierarchy filled with all elements which can compose a subscription (with other accesses on other activation charges included). Please consult subscription documentation for more information.

Operation Result

SearchSubscriptionFromAccessResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchSubscriptionFromAccess">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="accessSearchFilter" 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:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeNoYesNoNoNoNo
  • Field Details

  • Constructor Details

    • SearchSubscriptionFromAccessOp

      public SearchSubscriptionFromAccessOp()
      Builds an empty SearchSubscriptionFromAccessOp.
  • Method Details

    • getName

      public String getName()
      Gets the name of the related XML element.
      Specified by:
      getName in interface MessageOperation
      Returns:
      the name.
    • getFilter

      public AccessSearchFilterModel getFilter()
      Gets the access filter.
      Returns:
      the filter to apply.
    • setFilter

      public void setFilter(AccessSearchFilterModel filter)
      Sets the access filter.
      Parameters:
      filter - the filter to apply.
    • 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
    • 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
    • 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
    • marshal

      public void marshal(XMLOutputter output)
      Description copied from interface: XMLMarshallable
      Gives an XML representation of this object, including its children.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XML output to marshal the object into