com.highdeal.pnr.hci

Class ClearPrepaidAccountOp

java.lang.Object

com.highdeal.pnr.hci.ClearPrepaidAccountOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class ClearPrepaidAccountOp
extends java.lang.Object
implements MessageOperation

This operation allows to clear a prepaid account in a subscriber account; It sets the balance amount of the prepaid account to 0.

Implementation in Your Client Application

This operation has to be alone in an envelope or with others Clear Prepaid Account operations or Refill Prepaid Account operation.

Note

If a ClearPrepaidAccountOp is present in an envelope with others operations that are neither ClearPrepaidAccountOp or RefillPrepaidAccountOp, then an incompatibleOperationFault is returned.

See Also:

IncompatibleOperationException

Operation Result

ClearPrepaidAccountResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="clearPrepaidAccount">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="prepaidAccountCode" minOccurs="0" maxOccurs="unbounded">
         <xs:complexType>
           <xs:attribute name="value" type="xs:string" use="required"/>
         </xs:complexType>
       </xs:element>
     </xs:sequence>
     <xs:attribute name="subscriberAccountId" type="xs:integer"/>
     <xs:attribute name="subscriberAccountCode" type="xs:string" use="required"/>
     <xs:attribute name="serviceProvider" type="xs:string" use="required"/>
     <xs:attribute name="enableAmountAlert" 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

Audit Domain

This operation is audited by the system as part of the audit domain: CUSTOMER. Consult the IT administrator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML tag name of this service operation request: "clearPrepaidAccount"

Constructor Summary

Constructors

Constructor and Description
ClearPrepaidAccountOp() Builds an empty clear subscriber account operation.

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	getName() Gets the name of the clear prepaid account operation.
java.util.List<java.lang.String>	getPrepaidAccountCodes() Returns the list of codes of prepaid accounts.
java.lang.String	getServiceProvider() Gets the service provider of the clear prepaid account operation.
java.lang.String	getSubscriberAccountCode() Gets the subscriber account code of the clear prepaid account operation.
java.lang.Long	getSubscriberAccountId() Gets the ID of the subscriber account.
boolean	isAmountAlertEnabled() Tests if the amount alert is enabled for this clear prepaid account operation.
void	isAmountAlertEnabled(boolean amountAlertEnabled) Enables or disables the amount alert on this clear prepaid account operation.
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	setServiceProvider(java.lang.String serviceProvider) Sets service provider of the clear prepaid account operation.
void	setSubscriberAccountCode(java.lang.String subscriberAccountCode) Sets the subscriber account code of the clear prepaid account operation.
void	setSubscriberAccountId(java.lang.Long suacId) Sets the ID of the subscriber account.

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 tag name of this service operation request: "clearPrepaidAccount"

See Also:

Constant Field Values

Constructor Detail

ClearPrepaidAccountOp

public ClearPrepaidAccountOp()

Builds an empty clear subscriber account operation.

Method Detail

getName

public java.lang.String getName()

Gets the name of the clear prepaid account operation.

Specified by:

getName in interface MessageOperation

Returns:

The name of the clear prepaid account operation

isAmountAlertEnabled

public boolean isAmountAlertEnabled()

Tests if the amount alert is enabled for this clear prepaid account operation.

Returns:

true if the amount alert has to be enabled, false otherwise

isAmountAlertEnabled

public void isAmountAlertEnabled(boolean amountAlertEnabled)

Enables or disables the amount alert on this clear prepaid account operation.

Parameters:

amountAlertEnabled - true to enable the amount alert on this clear prepaid operation, false otherwise

getPrepaidAccountCodes

public java.util.List<java.lang.String> getPrepaidAccountCodes()

Returns the list of codes of prepaid accounts.

Returns:

The list of codes of prepaid accounts

getServiceProvider

public java.lang.String getServiceProvider()

Gets the service provider of the clear prepaid account operation.

Returns:

The service provider of the clear prepaid account operation

setServiceProvider

public void setServiceProvider(java.lang.String serviceProvider)

Sets service provider of the clear prepaid account operation.

Parameters:

serviceProvider - The service provider of the clear prepaid account operation

getSubscriberAccountCode

public java.lang.String getSubscriberAccountCode()

Gets the subscriber account code of the clear prepaid account operation.

Returns:

The subscriber account code of the clear prepaid account operation

setSubscriberAccountCode

public void setSubscriberAccountCode(java.lang.String subscriberAccountCode)

Sets the subscriber account code of the clear prepaid account operation.

Parameters:

subscriberAccountCode - The subscriber account code of the clear prepaid account operation

setSubscriberAccountId

public void setSubscriberAccountId(java.lang.Long suacId)

Sets the ID of the subscriber account.

Parameters:

suacId - The identifier of the subscriber account

getSubscriberAccountId

public java.lang.Long getSubscriberAccountId()

Gets the ID of the subscriber account.

Returns:

The identifier of the subscriber account

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

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

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

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