com.highdeal.pnr.hci

Class TranslateValueOp

java.lang.Object

com.highdeal.pnr.hci.TranslateValueOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class TranslateValueOp
extends java.lang.Object
implements MessageOperation

This operation allows to request for the interrogation of a translation table instance from a set of input values and returns corresponding output values.

Error Handling

If the translation table does not exist, the connected SAP CC system launches a DoesNotExistException.

Operation Result

TranslateValueResult

Operation Failure Exceptions

• DoesNotExistException
• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="translate">
   <xs:complexType>
     <xs:attribute name="tableCode" type="xs:string"/>
     <xs:attribute name="operator" type="xs:string"/>
     <xs:attribute name="date" type="xs:dateTime"/>
     <xs:attribute name="referenceDate" type="xs:dateTime" use="optional" />
     <xs:attribute name="i0" type="xs:string"/>
     <xs:attribute name="i1" type="xs:string"/>
     <xs:attribute name="i2" type="xs:string"/>
     <xs:attribute name="i3" type="xs:string"/>
     <xs:attribute name="i4" type="xs:string"/>
   </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
TranslateValueOp() Builds an empty 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.Date	getDate() Returns the date used for the translate operation.
java.lang.String	getInValue(int i) Returns the input value used for the translate operation.
java.lang.String	getName() The name of the operation is "translate".
int	getOperator() Gets the operator.
java.util.Date	getReferenceDate() Returns the reference date, it used to check column "start date" and column "end date".
java.lang.String	getTableCode() Returns the translation table code used for the translate operation.
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	setDate(java.util.Date d) Sets the date used for the translate operation.
void	setInValue(int i, java.lang.String v) Sets the input value used for the translate operation.
void	setOperator(int o) Sets the operator.
void	setReferenceDate(java.util.Date d) Sets the reference date is used to check column "start date" and column "end date".
void	setTableCode(java.lang.String table) Sets the translation table code used for the translate operation.

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

TranslateValueOp

public TranslateValueOp()

Builds an empty operation.

Method Detail

getName

public java.lang.String getName()

The name of the operation is "translate".

Specified by:

getName in interface MessageOperation

Returns:

"translate"

getTableCode

public java.lang.String getTableCode()

Returns the translation table code used for the translate operation.

Returns:

The translation table code used for the translate operation

setTableCode

public void setTableCode(java.lang.String table)

Sets the translation table code used for the translate operation.

Parameters:

table - The translation table code used for the translate operation

getDate

public java.util.Date getDate()

Returns the date used for the translate operation.

Returns:

The date used for the translate operation

setDate

public void setDate(java.util.Date d)

Sets the date used for the translate operation.

Parameters:

d - The date used for the translate operation

getReferenceDate

public java.util.Date getReferenceDate()

Returns the reference date, it used to check column "start date" and column "end date".

Returns:

The date used for the translate operation

setReferenceDate

public void setReferenceDate(java.util.Date d)

Sets the reference date is used to check column "start date" and column "end date".

Parameters:

d - The date used for the translate operation

getOperator

public int getOperator()

Gets the operator.

Returns:

The operator

setOperator

public void setOperator(int o)

Sets the operator.

Parameters:

o - The operator

getInValue

public java.lang.String getInValue(int i)

Returns the input value used for the translate operation.

Parameters:

i - The rank of the input value to return

Returns:

The input value used for the translate operation

setInValue

public void setInValue(int i,
                       java.lang.String v)

Sets the input value used for the translate operation.

Parameters:

i - The rank of the input value to set

v - The value used for the translate operation

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