com.highdeal.pnr.hci

Class SearchTranslationRowsOp

java.lang.Object

com.highdeal.pnr.hci.SearchTranslationRowsOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchTranslationRowsOp
extends java.lang.Object
implements MessageOperation

This operation allows to retrieve translation table rows from a charge condition in a given offer, at a given date. Translation rows are selected according to criteria defined in attributeDescription. If no criteria is defined, all applicable translation rows for the charge condition are returned.

Operation Result

SearchTranslationRowsResult

Operation Failure Exceptions

• InvalidSearchException
• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchTranslationRows">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="attributeDescription" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="chargeConditionSubCode" type="xs:string" use="required"/>
    <xs:attribute name="rootOfferCode" type="xs:string" use="required"/>
    <xs:attribute name="tableCode" type="xs:string" use="required"/>
    <xs:attribute name="date" type="xs:dateTime" use="required"/>
    <xs:attribute name="maxSize" type="xs:integer" default="50"/>
  </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

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME

Constructor Summary

Constructors

Constructor and Description
SearchTranslationRowsOp() Builds an empty search translation rows operation.

Method Summary

Modifier and Type	Method and Description
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.
java.util.Vector<AttributeDescriptionModel>	getAttributeDescriptions() Returns the list of AttributeDescriptionModel.
java.lang.String	getChargeConditionSubCode() Returns the charge condition subCode.
java.util.Date	getDate() Returns the date allowing to retrieve the right version of translation rows.
int	getMaxSize() Returns the max number of translation rows returned by the operation.
java.lang.String	getName() Gets the name.
java.lang.String	getRootOfferCode() Returns the code of the root offer.
java.lang.String	getTableCode() Returns the table code.
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	setChargeConditionSubCode(java.lang.String chargeConditionSubCode) Sets the charge condition subCode.
void	setDate(java.util.Date date) Sets the date allowing to retrieve the right version of translation rows.
void	setMaxSize(int maxSize) Sets the max number of translation rows returned by the operation.
void	setRootOfferCode(java.lang.String rootOfferCode) Sets the code of the root offer.
void	setTableCode(java.lang.String tableCode) Sets the table code.

Methods inherited from class java.lang.Object

equals, 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

SearchTranslationRowsOp

public SearchTranslationRowsOp()

Builds an empty search translation rows operation.

Method Detail

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface MessageOperation

Returns:

"searchTranslationRows".

getChargeConditionSubCode

public java.lang.String getChargeConditionSubCode()

Returns the charge condition subCode.

Returns:

the charge condition subCode.

See Also:

setChargeConditionSubCode(String)

setChargeConditionSubCode

public void setChargeConditionSubCode(java.lang.String chargeConditionSubCode)

Sets the charge condition subCode.

Parameters:

chargeConditionSubCode -

See Also:

getChargeConditionSubCode()

getRootOfferCode

public java.lang.String getRootOfferCode()

Returns the code of the root offer.

Returns:

the root offer code.

See Also:

setRootOfferCode(String)

setRootOfferCode

public void setRootOfferCode(java.lang.String rootOfferCode)

Sets the code of the root offer.

Parameters:

rootOfferCode -

See Also:

getRootOfferCode()

getTableCode

public java.lang.String getTableCode()

Returns the table code.

Returns:

the table code.

See Also:

setTableCode(String)

setTableCode

public void setTableCode(java.lang.String tableCode)

Sets the table code.

Parameters:

tableCode -

See Also:

getTableCode()

getDate

public java.util.Date getDate()

Returns the date allowing to retrieve the right version of translation rows.

Returns:

the date allowing to retrieve the right version of translation rows.

See Also:

setDate(Date)

setDate

public void setDate(java.util.Date date)

Sets the date allowing to retrieve the right version of translation rows.

Parameters:

date -

See Also:

getDate()

getMaxSize

public int getMaxSize()

Returns the max number of translation rows returned by the operation.

Returns:

.

See Also:

setMaxSize(int)

setMaxSize

public void setMaxSize(int maxSize)

Sets the max number of translation rows returned by the operation.

Parameters:

maxSize -

See Also:

getMaxSize()

getAttributeDescriptions

public java.util.Vector<AttributeDescriptionModel> getAttributeDescriptions()

Returns the list of AttributeDescriptionModel.

Returns:

the list of AttributeDescriptionModel.

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