com.highdeal.pnr.hci

Class SearchExportableItemTemplateNamesOp

java.lang.Object

com.highdeal.pnr.hci.SearchExportableItemTemplateNamesOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchExportableItemTemplateNamesOp
extends java.lang.Object
implements MessageOperation

This operation class searches empty exportable item mapping names (which we name exportable item template) thank to the Exportable Item Framework (EIF).

Operation Result

SearchExportableItemTemplateNamesResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchExportableItemTemplateNames">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="additionalInformation" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="type" type="ExportableItemTemplateType" use="optional" />
   </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
SearchExportableItemTemplateNamesOp() Builds an empty SearchExportableItemTemplateNamesOp.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalInfo(AdditionalInfoModel additionalInfo) Adds a new additional info.
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.
AdditionalInfoModel	getAdditionalInfo(int index) Returns the additional info at the specified index.
java.util.List<AdditionalInfoModel>	getAdditionalInfoList() Returns the addtional info list.
java.lang.String	getName() Gets the name.
ExportableItemTemplateType	getType() Gets the exportable item template type.
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	setType(ExportableItemTemplateType type) Sets the exportable item template type.

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

SearchExportableItemTemplateNamesOp

public SearchExportableItemTemplateNamesOp()

Builds an empty SearchExportableItemTemplateNamesOp.

Method Detail

getType

public ExportableItemTemplateType getType()

Gets the exportable item template type.

Returns:

the exportable item template type.

setType

public void setType(ExportableItemTemplateType type)

Sets the exportable item template type.

Parameters:

type - the exportable item template type.

addAdditionalInfo

public void addAdditionalInfo(AdditionalInfoModel additionalInfo)

Adds a new additional info. Do nothing if additionalInfo is null.

Parameters:

additionalInfo - the additional info to be added.

getAdditionalInfo

public AdditionalInfoModel getAdditionalInfo(int index)

Returns the additional info at the specified index.

Parameters:

index - the index of the additional info to be returned.

Returns:

the additional info stored at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is greater than the additional info count or negative.

getAdditionalInfoList

public java.util.List<AdditionalInfoModel> getAdditionalInfoList()

Returns the addtional info list.

Returns:

an array of additional info.

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface MessageOperation

Returns:

the name.

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