Package com.highdeal.pnr.hci

Class SearchCodeOp

java.lang.Object

com.highdeal.pnr.hci.SearchCodeOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchCodeOp
extends Object
implements MessageOperation

This operation allows searchinf for an object by specifying its type and optionally its owner and return an object code list.

Searched objects can be:

• Product
• Chargeable Item Class
• Charged Item Class
• Pricing Macro
• Translation Table
• Tier Table
• Mapping Table Class
• Mapping Table
• Range Table Class
• Range Table
• Offer
• Charge Component
• Charge Plan
• Refill Item Class
• Refill Logic
• Refill Record Class
• Refill Plan
• Refill Logic
• Charged Item Aggregation Policy
• Allowance Logic
• Allowance Plan
• Monitoring Plan

Operation Result

SearchCodeResult

Operation Failure Exceptions

• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchCode">
   <xs:complexType>
     <xs:attribute name="object" type="CatalogEntryTypeType"/>
     <xs:attribute name="withModelCompatibility" type="xs:boolean"/>
     <xs:attribute name="owner" type="xs:string"/>
   </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	Description
static final String	OPERATION_NAME

Constructor Summary

Constructors

Constructor	Description
SearchCodeOp()

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.
String	getName()	Gets the name.
String	getObjectType()	Gets the object type.
String	getOwner()	Gets the owner.
boolean	getWithModelCompatibility()
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	setObjectType(String object)	Sets the object type.
void	setOwner(String o)	Sets the owner.
void	setWithModelCompatibility(boolean withCompatibility)	Sets the model compatibility.

Methods inherited from class java.lang.Object

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

Field Details

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

• Constant Field Values

Constructor Details

SearchCodeOp

public SearchCodeOp()

Method Details

getName

public String getName()

Gets the name.

Specified by:

getName in interface MessageOperation

Returns:

The name

getObjectType

public String getObjectType()

Gets the object type.

Returns:

The object type

setObjectType

public void setObjectType(String object)

Sets the object type.

Parameters:

object - The object type

getOwner

public String getOwner()

Gets the owner.

Returns:

The owner

setOwner

public void setOwner(String o)

Sets the owner.

Parameters:

o - The owner

setWithModelCompatibility

public void setWithModelCompatibility(boolean withCompatibility)

Sets the model compatibility.

Parameters:

withCompatibility - The compatibility

getWithModelCompatibility

public boolean getWithModelCompatibility()

Returns:

The model compatibility

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