com.highdeal.pnr.hci

Class SearchExportableItemTemplateNamesResult

java.lang.Object

com.highdeal.pnr.hci.SearchExportableItemTemplateNamesResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class SearchExportableItemTemplateNamesResult
extends java.lang.Object
implements OperationResult

This class represents the result of the SearchExportableItemTemplateNamesOp operation.

Operation Request

SearchExportableItemTemplateNamesOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

  <xs:element name="externalSystem">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="template" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
     <xs:attribute name="code" type="xs:string"/>
    </xs:complexType>
  </xs:element>

  <xs:element name="template">
    <xs:complexType>
     <xs:attribute name="code" type="xs:string"/>
     <xs:attribute name="description" type="xs:string" use="optional"/>
    </xs:complexType>
  </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTERNAL_SYSTEM_NAME The XML tag for an external system.
static java.lang.String	RESULT_NAME The XML tag for the result.
static java.lang.String	TEMPLATE_NAME The XML tag for the name/description of an exportable item template.

Constructor Summary

Constructors

Constructor and Description
SearchExportableItemTemplateNamesResult() Builds an empty SearchExportableItemTemplateNamesResult.

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.Map<java.lang.String,java.util.List<java.lang.String>>	getExportableItemTemplateNames() Gets the map of exportable item names by external system code.
java.util.Map<java.lang.String,java.util.List<com.highdeal.util.Pair<java.lang.String,java.lang.String>>>	getExportableItemTemplates() Gets the map of template names and descriptions by external system code.
java.lang.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.
java.util.List<java.lang.String>	getTemplateNamesFromExternalSystemCode(java.lang.String externalSystemCode) Gets the list of template names from an externalSystem 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	setExportableItemTemplateNames(java.util.Map<java.lang.String,java.util.List<java.lang.String>> templateNamesMap) Sets the map of exportable item names by external system code.
void	setExportableItemTemplates(java.util.Map<java.lang.String,java.util.List<com.highdeal.util.Pair<java.lang.String,java.lang.String>>> templateMap) Sets the map of template names and descriptions by external system code.

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME

The XML tag for the result.

See Also:

Constant Field Values

EXTERNAL_SYSTEM_NAME

public static final java.lang.String EXTERNAL_SYSTEM_NAME

The XML tag for an external system.

See Also:

Constant Field Values

TEMPLATE_NAME

public static final java.lang.String TEMPLATE_NAME

The XML tag for the name/description of an exportable item template.

See Also:

Constant Field Values

Constructor Detail

SearchExportableItemTemplateNamesResult

public SearchExportableItemTemplateNamesResult()

Builds an empty SearchExportableItemTemplateNamesResult.

Method Detail

getExportableItemTemplates

public java.util.Map<java.lang.String,java.util.List<com.highdeal.util.Pair<java.lang.String,java.lang.String>>> getExportableItemTemplates()

Gets the map of template names and descriptions by external system code.

Returns:

the map of template names and descriptions by external system code

setExportableItemTemplates

public void setExportableItemTemplates(java.util.Map<java.lang.String,java.util.List<com.highdeal.util.Pair<java.lang.String,java.lang.String>>> templateMap)

Sets the map of template names and descriptions by external system code.

Parameters:

templateMap - the map of template names and descriptions by external system code

getTemplateNamesFromExternalSystemCode

public java.util.List<java.lang.String> getTemplateNamesFromExternalSystemCode(java.lang.String externalSystemCode)

Gets the list of template names from an externalSystem code.

Parameters:

externalSystemCode - an external system code

Returns:

a list of name as string

getExportableItemTemplateNames

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExportableItemTemplateNames()

Gets the map of exportable item names by external system code.

Returns:

the map of exportable item names

setExportableItemTemplateNames

public void setExportableItemTemplateNames(java.util.Map<java.lang.String,java.util.List<java.lang.String>> templateNamesMap)

Sets the map of exportable item names by external system code.

Parameters:

templateNamesMap - the map of exportable item names by external system code

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

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

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

getOperandReference

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