Package com.highdeal.pnr.hci

Class SearchCodeResult

java.lang.Object

com.highdeal.pnr.hci.SearchCodeResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class SearchCodeResult
extends Object
implements OperationResult

This class represents the result of the Search Code operation.

Operation Request

SearchCodeOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchCodeResult">
   <xs:complexType>
    <xs:sequence>
      <xs:element ref="objectCode" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
   </xs:complexType>
  </xs:element>

  <xs:element name="objectCode">
    <xs:complexType>
     <xs:attribute name="code" type="xs:string"/>
     <xs:attribute name="subCode" type="xs:string"/>
     <xs:attribute name="modelCompatibility">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="offer"/>
           <xs:enumeration value="chargePlan"/>
           <xs:enumeration value="allowancePlan"/>
         </xs:restriction>
       </xs:simpleType>
       </xs:attribute>
    </xs:complexType>
  </xs:element>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchCodeResult.ModelCompatibility
static class	SearchCodeResult.ObjectCode

Constructor Summary

Constructors

Constructor	Description
SearchCodeResult()	Builds an empty SearchCodeResult.

Method Summary

Modifier and Type	Method	Description
void	addCharacterData(String cData)	Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child)	Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addCode(String code, SearchCodeResult.ModelCompatibility compatibility)	Deprecated.
void	addObjectCode(SearchCodeResult.ObjectCode obj)
Vector<String>	getCodes()	Deprecated.
Vector<SearchCodeResult.ModelCompatibility>	getModelCompatiblity()	Deprecated.
List<SearchCodeResult.ObjectCode>	getObjectCodes()
String	getOperandReference()	Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
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.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchCodeResult

public SearchCodeResult()

Builds an empty SearchCodeResult.

Method Details

getObjectCodes

public List<SearchCodeResult.ObjectCode> getObjectCodes()

addObjectCode

public void addObjectCode(SearchCodeResult.ObjectCode obj)

getCodes

@Deprecated
public Vector<String> getCodes()

Deprecated.

Gets the found codes.

Returns:

The Vector of found string codes

addCode

@Deprecated
public void addCode(String code,
 SearchCodeResult.ModelCompatibility compatibility)

Deprecated.

getModelCompatiblity

@Deprecated
public Vector<SearchCodeResult.ModelCompatibility> getModelCompatiblity()

Deprecated.

getOperandReference

public String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

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(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(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