Package com.highdeal.pnr.hci
Class SearchSubscriptionFromAccessOp
java.lang.Object
com.highdeal.pnr.hci.SearchSubscriptionFromAccessOp
- All Implemented Interfaces:
MessageOperation,XMLMarshallable
This operation allows retrieving any subscription from an access selection by
using a
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
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:
| Edition | Final Target Instances | |||||
| rater | updater | guider | bulkLoader | taxer | dispatcher | |
| charge | No | Yes | No | No | No | No |
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionBuilds an empty SearchSubscriptionFromAccessOp. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCharacterData(String cData) Adds character data to the content element.voidaddChild(String tagName, XMLMarshallable child) Adds a child to the object, thechildrepresenting the marshallable object which must be added to the element.Gets the access filter.getName()Gets the name of the related XML element.voidmarshal(XMLOutputter output) Gives an XML representation of this object, including its children.voidsetAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.voidsetFilter(AccessSearchFilterModel filter) Sets the access filter.
-
Field Details
-
OPERATION_NAME
- See Also:
-
-
Constructor Details
-
SearchSubscriptionFromAccessOp
public SearchSubscriptionFromAccessOp()Builds an empty SearchSubscriptionFromAccessOp.
-
-
Method Details
-
getName
Gets the name of the related XML element.- Specified by:
getNamein interfaceMessageOperation- Returns:
- the name.
-
getFilter
Gets the access filter.- Returns:
- the filter to apply.
-
setFilter
Sets the access filter.- Parameters:
filter- the filter to apply.
-
setAttributes
Description copied from interface:XMLMarshallableSets the attributes of the XML representation of the element being processed.- Specified by:
setAttributesin interfaceXMLMarshallable- Parameters:
atts- TheXML attributesof the current element
-
addCharacterData
Description copied from interface:XMLMarshallableAdds character data to the content element.- Specified by:
addCharacterDatain interfaceXMLMarshallable- Parameters:
cData- The character data to be added
-
addChild
Description copied from interface:XMLMarshallableAdds a child to the object, thechildrepresenting the marshallable object which must be added to the element.- Specified by:
addChildin interfaceXMLMarshallable- Parameters:
tagName- The name of tag for the childchild- The child to be added
-
marshal
Description copied from interface:XMLMarshallableGives an XML representation of this object, including its children.- Specified by:
marshalin interfaceXMLMarshallable- Parameters:
output- TheXML outputto marshal the object into
-