com.highdeal.pnr.hci

Class SearchChargeComponentOp

java.lang.Object

com.highdeal.pnr.hci.SearchChargeComponentOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchChargeComponentOp
extends Object
implements MessageOperation

This operation allows to retrieve charge components.The research is doing according to attributes code and-or owner. The withNoPricePlanInChronology attribute allows to return the chargeComponent with pricePlan (false) or without pricePlan (true) in the chronology [default value is false]. The pricePlanDate attribute allows to retrieve a specific price plan valid at the pricePlanDate [default value is null]. If this date is not null, the price plan valid at the pricePlanDate is saved like the chargeComponent pricePlan attribute (Use getPricePlan() on chargeComponentModel in order to retrieve it).

Operation Result

SearchChargeComponentResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchChargeComponent">
   <xs:complexType>
     <xs:attribute name="code" type="xs:string"/>
     <xs:attribute name="owner" type="xs:string"/>
     <xs:attribute name="pricePlanDate" type="xs:dateTime"/>
     <xs:attribute name="withNoPricePlanInChronology" type="xs:boolean" default="false"/>
   </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 String	OPERATION_NAME

Constructor Summary

Constructors

Constructor and Description
SearchChargeComponentOp()

Method Summary

Modifier and Type	Method and 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	getCode() Gets the code.
String	getName() Gets the name of the operation.
String	getOwner() Gets the owner.
Date	getPricePlanDate() Gets the price plan date.
boolean	isWithNoPricePlanInChronology() Gets the withNoPricePlanInChronology.
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(String code) Sets the code.
void	setOwner(String owner) Sets the owner.
void	setPricePlanDate(Date pricePlanDate) Sets the price plan date.
void	setWithNoPricePlanInChronology(boolean withNoPricePlanInChronology) Sets the withNoPricePlanInChronology.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

SearchChargeComponentOp

public SearchChargeComponentOp()

Method Detail

getCode

public String getCode()

Gets the code.

Returns:

the code.

setCode

public void setCode(String code)

Sets the code.

Parameters:

code - the code.

getOwner

public String getOwner()

Gets the owner.

Returns:

the owner.

setOwner

public void setOwner(String owner)

Sets the owner.

Parameters:

owner - the owner.

getPricePlanDate

public Date getPricePlanDate()

Gets the price plan date. Default value is null.

Returns:

the price plan date.

setPricePlanDate

public void setPricePlanDate(Date pricePlanDate)

Sets the price plan date. Default value is null.

Parameters:

pricePlanDate - the price plan date.

isWithNoPricePlanInChronology

public boolean isWithNoPricePlanInChronology()

Gets the withNoPricePlanInChronology. Allows to return chargeComponent with pricePlan or not. Default value is false.

Returns:

the price plan return status.

setWithNoPricePlanInChronology

public void setWithNoPricePlanInChronology(boolean withNoPricePlanInChronology)

Sets the withNoPricePlanInChronology. Allows to return chargeComponent with pricePlan or not. Default value is false.

Parameters:

withNoPricePlanInChronology - the price plan return status.

getName

public String getName()

Gets the name of the operation.

Specified by:

getName in interface MessageOperation

Returns:

"searchChargeComponent"

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