com.highdeal.pnr.hci
Class ChargeParameters

java.lang.Object
  com.highdeal.pnr.hci.ChargeParameters

All Implemented Interfaces:

XMLMarshallable

public class ChargeParameters
extends java.lang.Object
implements XMLMarshallable

This Java class represents a list of chargeable items sent in a batch charging operation request; See the offline charging services in com.highdeal.cnd.message. It includes:

• USID: The technical ID of the end customer who consumed the customer service (USID: User Service ID)
• SID: The technical ID of the customer service
• The consumption date of the customer service that applies to all the chargeable items
• The activation ID
• A list of chargeable items to be charged in batch mode and that include the service consumtion data in a set of properties

See Also:

AsyncBatchServiceClient, BatchServiceClient

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargeParameters">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="ci" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="userID" type="xs:string" use="required" />
     <xs:attribute name="serviceID" type="xs:string" use="required" />
     <xs:attribute name="consumptionDate" type="xs:dateTime" use="required"/>
     <xs:attribute name="activationID" type="xs:integer" />
   </xs:complexType>
 </xs:element>

Constructor Summary

ChargeParameters()
Constructs an empty Charge parameters

Method Summary

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.
long	getActivationID() Gets the activation ID for this charge operation.
java.util.Date	getConsumptionDate() Gets the consumption date of the customer service; this applies to the batch charging operation.
ChargeableItem	getItem() Returns the item to be charged.
java.lang.String	getName() The tag of this class is "chargeParameters".
java.lang.String	getServiceID() Gets the service ID for this batch charge operation.
java.lang.String	getUserID() Gets the user ID for this batch charge operation.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setActivationID(long activationID) Sets the activation ID for this charge operation.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setConsumptionDate(java.util.Date d) Sets the consumption date of the customer service; this applies to all the items in this batch charge operation.
void	setItem(ChargeableItem i) Sets the item to be charged in batch mode.
void	setServiceID(java.lang.String serviceID) Sets the service ID (SID) for this batch charge operation.
void	setUserID(java.lang.String userID) Sets the user ID for this batch charge operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChargeParameters

public ChargeParameters()

Constructs an empty Charge parameters

Method Detail

getName

public java.lang.String getName()

The tag of this class is "chargeParameters".

Returns:

"chargeParameters"

getItem

public ChargeableItem getItem()

Returns the item to be charged.

Returns:

The item to be charged

setItem

public void setItem(ChargeableItem i)

Sets the item to be charged in batch mode.

Parameters:

i - The item to be charged

getConsumptionDate

public java.util.Date getConsumptionDate()

Gets the consumption date of the customer service; this applies to the batch charging operation.

Returns:

The consumption date for this batch charge operation

setConsumptionDate

public void setConsumptionDate(java.util.Date d)

Sets the consumption date of the customer service; this applies to all the items in this batch charge operation.

Parameters:

d - The consumption date for this batch charge operation

getUserID

public java.lang.String getUserID()

Gets the user ID for this batch charge operation.

Returns:

The user id for this batch charge operation

setUserID

public void setUserID(java.lang.String userID)

Sets the user ID for this batch charge operation.

Parameters:

userID - The user ID for this batch charge operation

getServiceID

public java.lang.String getServiceID()

Gets the service ID for this batch charge operation.

Returns:

The service ID for this batch charge operation

setServiceID

public void setServiceID(java.lang.String serviceID)

Sets the service ID (SID) for this batch charge operation.

Parameters:

serviceID - The service ID for this batch charge operation

getActivationID

public long getActivationID()

Gets the activation ID for this charge operation.

Returns:

The activation ID

setActivationID

public void setActivationID(long activationID)

Sets the activation ID for this charge operation.

Parameters:

activationID - The activation ID value

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