com.highdeal.pnr.hci
Class SearchTierTableOp

java.lang.Object
  com.highdeal.pnr.hci.SearchTierTableOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchTierTableOp
extends java.lang.Object
implements MessageOperation

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 Exception

ServerFailureException

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

static java.lang.String

OPERATION_NAME

Constructor Summary

SearchTierTableOp()

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
TierTableSearchFilterModel	getFilter() Gets the filter used to search the tier tables.
java.lang.String	getName() Gets the name of the operation.
boolean	isSchemaOnly() Returns the value of the schemaOnly attribute.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setFilter(TierTableSearchFilterModel tierTableFilter) Sets the filter used to search the tier tables.
void	setSchemaOnly(boolean schemaOnly) Sets the value of the schemaOnly attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

SearchTierTableOp

public SearchTierTableOp()

Method Detail

getName

public java.lang.String getName()

Gets the name of the operation.

Specified by:

getName in interface MessageOperation

Returns:

"searchTierTable".

getFilter

public TierTableSearchFilterModel getFilter()

Gets the filter used to search the tier tables.

Returns:

the filter.

setFilter

public void setFilter(TierTableSearchFilterModel tierTableFilter)

Sets the filter used to search the tier tables.

Parameters:

tierTableFilter - the filter.

isSchemaOnly

public boolean isSchemaOnly()

Returns the value of the schemaOnly attribute. If it is true only the tables will be returned without their instances. To get both, it must be set to false.

Returns:

the value of the schemaOnly attribute.

setSchemaOnly

public void setSchemaOnly(boolean schemaOnly)

Sets the value of the schemaOnly attribute.

Parameters:

schemaOnly - the value of the schemaOnly attribute.

See Also:

isSchemaOnly()

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(java.lang.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(java.lang.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