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 class represents the interrogation of a translation table instance from a set of input values and returns corresponding output values. If the translation table does not exist, the server launches a DoesNotExistException.

See Also :

TranslateValueResult

Operation Failure Exception :

DoesNotExistException
ServerFailureException

Operation available with roles :

"admin"

XML Schema 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 :

Edition	Available On:
	Rater	Updater	Backup	Guider	Charger	BulkLoader	BillingAssistant	EZTaxer
Rate	no	yes	no	no	no	no	no	no
Charge	no	yes	no	no	no	no	no	no
Bill	no	yes	no	no	no	no	no	no
Full	no	yes	no	no	no	no	no	no

Constructor Summary

TranslateValueOp()
Builds an empty operation.

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 objects, the child represents the marshallable object to be added into the content tree.
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, and of its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag beeing 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

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

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 tag beeing processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - the XML attributes of the current tag.

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 objects, the child represents the marshallable object to be added into the content tree.

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, and of its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - the XML output to marshall the object into.