Package com.highdeal.pnr.hci
Class SearchTierTableOp
java.lang.Object
com.highdeal.pnr.hci.SearchTierTableOp
- All Implemented Interfaces:
MessageOperation,XMLMarshallable
This operation allows to retrieve any tier table
by using a
tierTableSearchFilter to build search criterias.
If schemaOnly is true, only the table schema is sent, else the table with its instances is sent.Operation Result
SearchTierTableResult Operation Failure Exceptions
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
<xs:element name="searchTierTable">
<xs:complexType>
<xs:sequence>
<xs:element ref="tierTableSearchFilter" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="schemaOnly" type="xs:boolean" 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:
| Edition | Final Target Instances | |||||
| rater | updater | guider | bulkLoader | taxer | dispatcher | |
| charge | No | Yes | No | No | No | No |
-
Field Summary
Fields -
Constructor Summary
Constructors -
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 filter used to search the tier tables.getName()Gets the name of the operation.booleanReturns the value of theschemaOnlyattribute.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(TierTableSearchFilterModel tierTableFilter) Sets the filter used to search the tier tables.voidsetSchemaOnly(boolean schemaOnly) Sets the value of theschemaOnlyattribute.
-
Field Details
-
OPERATION_NAME
- See Also:
-
-
Constructor Details
-
SearchTierTableOp
public SearchTierTableOp()
-
-
Method Details
-
getName
Gets the name of the operation.- Specified by:
getNamein interfaceMessageOperation- Returns:
- "searchTierTable".
-
getFilter
Gets the filter used to search the tier tables.- Returns:
- the filter.
-
setFilter
Sets the filter used to search the tier tables.- Parameters:
tierTableFilter- the filter.
-
isSchemaOnly
public boolean isSchemaOnly()Returns the value of theschemaOnlyattribute. If it istrueonly the tables will be returned without their instances. To get both, it must be set tofalse.- Returns:
- the value of the
schemaOnlyattribute.
-
setSchemaOnly
public void setSchemaOnly(boolean schemaOnly) Sets the value of theschemaOnlyattribute.- Parameters:
schemaOnly- the value of theschemaOnlyattribute.- See Also:
-
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
-