com.highdeal.pnr.hci

Class SearchExportableItemTemplateOp

java.lang.Object

com.highdeal.pnr.hci.SearchExportableItemTemplateOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchExportableItemTemplateOp
extends java.lang.Object
implements MessageOperation

This operation allows searching for empty exportable items mapping (which we name exportable item template) thank to the Exportable Item Framework (EIF).

Operation Result

SearchExportableItemTemplateResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchExportableItemTemplate">
   <xs:complexType>
     <xs:attribute name="externalSystemCode" type="xs:string" use="optional"/>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="type" type="ExportableItemTemplateType" use="optional" />
     <xs:attribute name="withDescriptions" type="xs:boolean" use="optional" default="true" />
   </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 The XML element name of this service operation: searchExportableItemTemplate

Constructor Summary

Constructors

Constructor and Description
SearchExportableItemTemplateOp()

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.lang.String	getCode() Gets the code of the exportable item template.
java.lang.String	getExternalSystemCode() Deprecated. Deprecated since version 4.0 of SAP CC; The external system code is no longer used to retrieve exportable item templates.
java.lang.String	getName() Gets the name.
ExportableItemTemplateType	getType() Gets the exportable item template type.
boolean	isWithDescriptions() Gets whether descriptions must be retrieved for template and template fields.
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	setCode(java.lang.String o) Sets the exportable item template code.
void	setExternalSystemCode(java.lang.String externalSystemCode) Deprecated. Deprecated since version 4.0 of SAP CC; The external system code is no longer used to retrieve exportable item templates.
void	setType(ExportableItemTemplateType type) Sets the exportable item template type.
void	setWithDescriptions(boolean withDescriptions) Sets whether descriptions must be retrieved for template and template fields.

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

The XML element name of this service operation: searchExportableItemTemplate

See Also:

Constant Field Values

Constructor Detail

SearchExportableItemTemplateOp

public SearchExportableItemTemplateOp()

Method Detail

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface MessageOperation

Returns:

The name

getCode

public java.lang.String getCode()

Gets the code of the exportable item template.

Returns:

The exportable item template code

setCode

public void setCode(java.lang.String o)

Sets the exportable item template code.

Parameters:

o - The exportable item template code

getExternalSystemCode

@Deprecated
public java.lang.String getExternalSystemCode()

Deprecated. Deprecated since version 4.0 of SAP CC; The external system code is no longer used to retrieve exportable item templates.

Gets the exportable item template externalSystemCode.

Returns:

The exportable item template externalSystemCode

setExternalSystemCode

@Deprecated
public void setExternalSystemCode(java.lang.String externalSystemCode)

Deprecated. Deprecated since version 4.0 of SAP CC; The external system code is no longer used to retrieve exportable item templates.

Sets the exportable item template externalSystemCode.

Parameters:

externalSystemCode - The exportable item template externalSystemCode

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

isWithDescriptions

public boolean isWithDescriptions()

Gets whether descriptions must be retrieved for template and template fields.

Returns:

true if descriptions must be retrieved for template and template fields, false otherwise

setWithDescriptions

public void setWithDescriptions(boolean withDescriptions)

Sets whether descriptions must be retrieved for template and template fields.

Parameters:

withDescriptions - true if descriptions must be retrieved for template and template fields, false otherwise

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