com.highdeal.pnr.hci

Class ExpirationAlertModel

java.lang.Object

com.highdeal.pnr.hci.ExpirationAlertModel

All Implemented Interfaces:

XMLMarshallable

public class ExpirationAlertModel
extends java.lang.Object
implements XMLMarshallable

This class represents an alert which must be notified by the SAP CC system before or after a reference date when the state of a prepaid account has changed.

See Also:

PrepaidAccountModel, AmountAlertModel, Notification

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="expirationAlert">
   <xs:complexType>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="refStateDate" type="ReferenceStateDate" use="required"/>
     <xs:attribute name="dayCount" type="xs:string" /> <!-- if doesn't exist, set to 0 --> 
   </xs:complexType>
 </xs:element>

<xs:simpleType name="ReferenceStateDate">
   <xs:restriction base="xs:string">
     <xs:enumeration value="active"/>
     <xs:enumeration value="blocked"/>
     <xs:enumeration value="locked"/>
     <xs:enumeration value="closed"/>
   </xs:restriction>
 </xs:simpleType>

Constructor Summary

Constructors

Constructor and Description
ExpirationAlertModel() Initializes an empty expiration alert.
ExpirationAlertModel(java.lang.String code, ReferenceStateDate referenceDateState, int dayCount) Initializes an expiration alert.

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() Returns the code of this alert.
int	getDayCount() Returns the number of day before/after the reference state date of the prepaid account this alert must be thrown.
ReferenceStateDate	getReferenceDateState() Returns the reference state date of this expiration alert.
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 code) Sets the code of this alert.
void	setDayCount(int dayCount) Sets the number of day before/after the reference state date of the prepaid account this alert must be thrown.
void	setReferenceDateState(ReferenceStateDate referenceDateState) Sets the reference state date of this expiration alert.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpirationAlertModel

public ExpirationAlertModel()

Initializes an empty expiration alert.

ExpirationAlertModel

public ExpirationAlertModel(java.lang.String code,
                            ReferenceStateDate referenceDateState,
                            int dayCount)

Initializes an expiration alert.

Parameters:

code - the code of the expiration alert.

referenceDateState - the reference date state

dayCount - the number of days before/after the reference date state this alert must be thrown.

Method Detail

getCode

public java.lang.String getCode()

Returns the code of this alert.

Returns:

a code.

setCode

public void setCode(java.lang.String code)

Sets the code of this alert.

Parameters:

code - the code of this alert.

getDayCount

public int getDayCount()

Returns the number of day before/after the reference state date of the prepaid account this alert must be thrown.

Returns:

a number of day to be added to the reference state date. Is negative if this alert must be thrown before the reference state date, positive otherwise.

setDayCount

public void setDayCount(int dayCount)

Sets the number of day before/after the reference state date of the prepaid account this alert must be thrown.

Parameters:

dayCount - a number of day to be added to the reference state date. Is negative if this alert must be thrown before the reference state date, positive otherwise.

getReferenceDateState

public ReferenceStateDate getReferenceDateState()

Returns the reference state date of this expiration alert.

Returns:

a reference state date if exists, null otherwise.

setReferenceDateState

public void setReferenceDateState(ReferenceStateDate referenceDateState)

Sets the reference state date of this expiration alert.

Parameters:

referenceDateState - the reference state date.

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