|
SAP CC 1.0
API 4.2 (Core) |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.highdeal.pnr.hci.SubscriptionModel
public class SubscriptionModel
This class represents a subscription model, which is an offer that is subscribed to by a customer as part of
a contract. When you create a subscription, charges that are described as mandatory in the offer
are automatically activated. You can then activate optional charges and sub-offers in the subscription according to
the contract with the subscriber. A subscription may contain several sub-subscriptions, which are subscriptions to
sub-offers.
All sub-subscriptions contained by this subscription must be linked to offerCondition
directly contained by the offer of this subscription.
All chargeActivation contained by this subscription must be linked to
chargeCondition directly contained by the offer of this subscription.
A subscription may be configured with one of these three distinct types:
Offline: it is always charged batch. This subscription generates
snapshots, which are backups of its counter values for rerating purpose. It belongs to one and only one batch
rating group.Hybrid: it is charged both in realtime and batch, depending for
example on the service that is consumed. It belongs to a batch rating group but, contrary to an offline
subscription, it is not compatible with rerating but is designed to be charged in realtime.Online: it is charged in realtime. It is not compatible with
rerating.parameterSet himself stored
in a chronology managed subscriptionContext.chargeActivation level parameters are stored in a chronology managed parameterSet stored
in each chargeActivation.parameter in a subscription, whatever the level is, is the same as building the target subscription
(with it's parameters redefined each level) and send it to the server via a ModifySubscriptionOp operation.parameter sets and translation tables exceptions that must be applied at a specified dateparameter was already redefined (the subscription didn't follow the standard parameters values). You just need to retrieve the parameter and change it's value.parameter was not already defined. You need to create a parameter with the new value and insert it at the right place.
| XML Schema Fragment |
<xs:element name="subscription">
<xs:complexType>
<xs:sequence>
<xs:element ref="subscriptionContext" minOccurs="0" maxOccurs="1"/>
<xs:element ref="subscription" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="chargeActivation" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="additionalInformation" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="counter" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="subscriptionContextChronology" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="code" type="xs:string"/> <!-- mandatory for a root subscription -->
<xs:attribute name="reference" type="xs:string"/>
<xs:attribute name="offerCode" type="xs:string" use="required"/>
<xs:attribute name="offerConditionCode" type="xs:string"/>
<xs:attribute name="subscriberAccountCode" type="xs:string" use="required"/>
<xs:attribute name="subscriberAccountServiceProvider" type="xs:string" use="required"/>
<xs:attribute name="reratingLockCode" type="xs:string"/>
<xs:attribute name="reratingLastCode" type="xs:string"/>
<xs:attribute name="reratingLastStatus" type="ReratingLastStatusType"/>
<xs:attribute name="type" type="SubscriptionTypeType"/>
<xs:attribute name="batchRatingGroupCode" type="xs:string"/>
<xs:attribute name="effective" type="xs:dateTime"/> <!-- mandatory for a root subscription -->
<xs:attribute name="expiration" type="xs:dateTime"/>
<xs:attribute name="priceFreezeEffective" type="xs:dateTime"/>
<xs:attribute name="priceFreezeExpiration" type="xs:dateTime"/>
<xs:attribute name="commitmentExpiration" type="xs:dateTime"/>
<xs:attribute name="suspensionDate" type="xs:dateTime"/>
<xs:attribute name="resumptionDate" type="xs:dateTime"/>
<xs:attribute name="cancellationDate" type="xs:dateTime"/>
<xs:attribute name="lastSnapshotDate" type="xs:dateTime"/>
<xs:attribute name="overrideDependencies" type="xs:boolean" use="optional"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="SubscriptionTypeType">
<xs:restriction base="xs:string">
<xs:enumeration value="online"/>
<xs:enumeration value="hybrid"/>
<xs:enumeration value="offline"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReratingLastStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="alreadyLockedFailure"/>
<xs:enumeration value="counterRestorationFailure"/>
<xs:enumeration value="billingFailure"/>
<xs:enumeration value="bartRestorationFailure"/>
<xs:enumeration value="exportFailure"/>
<xs:enumeration value="unlockFailure"/>
<xs:enumeration value="exportAndUnlockFailure"/>
<xs:enumeration value="restorationSuccess"/>
<xs:enumeration value="reratingSuccess"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="subscriptionContextChronology">
<xs:complexType>
<xs:sequence>
<xs:element ref="chronology" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element> |
| Nested Class Summary | |
|---|---|
static class |
SubscriptionModel.ReratingStatus
|
static class |
SubscriptionModel.SubscriptionType
|
| Field Summary | |
|---|---|
static int |
ACTIVE_STATUS
Status for active subscription. |
static int |
CLOSED_STATUS
Status for closed subscription. |
static int |
LOCKED_STATUS
Status for locked subscription. |
| Constructor Summary | |
|---|---|
SubscriptionModel()
Builds an empty SubscriptionModel. |
|
| Method Summary | |
|---|---|
void |
addCharacterData(java.lang.String cData)
Adds character data to the content element. |
void |
addChargeActivation(ChargeActivationModel activation)
|
void |
addChargeActivation(ChargeActivationModel activation,
boolean generateSubCode)
|
void |
addChild(java.lang.String name,
XMLMarshallable child)
Adds a child to the objects, the child represents
the marshallable object to be added into the content tree. |
void |
addSubscription(SubscriptionModel sub)
|
java.util.Vector<AdditionalInfoModel> |
getAdditionalInfos()
Returns the list of AdditionalInfoModel. |
java.lang.String |
getBatchRatingGroupCode()
Returns the batch rating group code that subscription has registered to. |
java.util.Date |
getCancellationDate()
Returns the cancellation date of this subscription. |
java.util.Vector<ChargeActivationModel> |
getChargeActivations()
Returns the list of ChargeActivationModel. |
java.lang.String |
getCode()
Returns the code of this subscription. |
java.util.Date |
getCommitmentExpiration()
Returns the commitment expiration date of this subscription. |
SubscriptionContextModel |
getContext()
Returns the subscription context. |
ChronologyModel |
getContextChronology()
Returns the offer context chronology of this subscription. |
java.util.Vector<CounterModel> |
getCounters()
Returns the list of CounterModel. |
java.util.Date |
getEffective()
Returns the effective date of this subscription. |
java.util.Date |
getExpiration()
Returns the expiration date of this subscription. |
java.util.Date |
getLastSnapshotDate()
Returns the last snapshot date of this subscription. |
java.lang.String |
getOfferCode()
Returns the code of the subscribed offer. |
java.lang.String |
getOfferConditionCode()
Returns the code of the offer condition of the subscribed offer. |
SubscriptionModel |
getParent()
Returns the subscription parent. |
java.util.Date |
getPriceFreezeEffective()
Returns the price freeze effective date of this subscription. |
java.util.Date |
getPriceFreezeExpiration()
Returns the price freeze expiration date of this subscription. |
java.lang.String |
getReference()
Returns the reference of this subscription. |
java.lang.String |
getReratingLastCode()
Returns the last rerating code of this subscription. |
SubscriptionModel.ReratingStatus |
getReratingLastStatus()
Returns the rerating status of the subscription. |
java.lang.String |
getReratingLockCode()
Gets the code of the rerating operation that has locked this subscription. |
java.util.Date |
getResumptionDate()
Returns the resumption date of this subscription. |
java.lang.String |
getSubscriberAccountCode()
Returns the code of the subscriber account for this subscription. |
java.lang.String |
getSubscriberAccountServiceProvider()
Returns the service provider of the subscriber account for this subscription. |
java.util.Vector<SubscriptionModel> |
getSubscriptions()
Returns the subscriptions. |
java.util.Date |
getSuspensionDate()
Returns the suspension date of this subscription. |
SubscriptionModel.SubscriptionType |
getType()
Returns the type of the subscription. |
boolean |
isOverrideDependencies()
Returns whether the subscription overrides the charge dependencies of the offer. |
void |
marshal(XMLOutputter output)
Gives an XML representation of this object, and of its children. |
void |
removeSubscription(SubscriptionModel sub)
|
java.util.Vector<ChargeActivationModel> |
retrieveAllCharges()
Returns the charge activations of this subscription and all the charge activation of its sub-subcriptions. |
java.util.Vector<SubscriptionModel> |
retrieveAllSubscriptions()
Returns all the subscription which has this subscription as ancestor. |
java.util.Vector<ChargeActivationModel> |
retrieveInvalidChargeSubCodes()
Returns all the invalid charge activation sub codes. |
void |
setAttributes(XMLAttributes atts)
Sets the attributes of the XML representation of the tag beeing processed. |
void |
setBatchRatingGroupCode(java.lang.String batchRatingGroupCode)
Sets the batch rating group code that subscription must registered to. |
void |
setCancellationDate(java.util.Date cancellationDate)
Sets the cancellation date of this subscription. |
void |
setCode(java.lang.String code)
Sets the code for this subscription. |
void |
setCommitmentExpiration(java.util.Date commitmentExpiration)
Sets the commitment expiration date of this subscription. |
void |
setContext(SubscriptionContextModel context)
Sets the context of this subscription. |
void |
setEffective(java.util.Date effective)
Sets the effective date of this subscription. |
void |
setExpiration(java.util.Date expiration)
Sets the expiration date of this subscription. |
void |
setLastSnapshotDate(java.util.Date lastSnapshotDate)
Sets the last snapshot date of this subscription. |
void |
setOfferCode(java.lang.String offerCode)
Sets the code of the subscribed offer. |
void |
setOfferConditionCode(java.lang.String offerConditionCode)
Sets the code of the offer condition of the subscribed offer. |
void |
setOverrideDependencies(boolean override)
Sets whether the subscription overrides the charge dependencies of the offer. |
void |
setParent(SubscriptionModel parent)
Sets the parent for this subscription. |
void |
setPriceFreezeEffective(java.util.Date priceFreezeEffective)
Sets the price freeze effective date of this subscription. |
void |
setPriceFreezeExpiration(java.util.Date priceFreezeExpiration)
Sets the price freeze expiration date of this subscription. |
void |
setReference(java.lang.String reference)
Sets the reference of this subscription. |
void |
setReratingLastCode(java.lang.String reratingLastCode)
Sets the last rerating code of this subscription. |
void |
setReratingLastStatus(SubscriptionModel.ReratingStatus reratingLastStatus)
Sets the rerating status of the subscription, which must be a value among SubscriptionModel.ReratingStatus.ALREADY_LOCKED_FAILURE, SubscriptionModel.ReratingStatus.COUNTER_RESTORATION_FAILURE,
SubscriptionModel.ReratingStatus.BART_RESTORATION_FAILURE or SubscriptionModel.ReratingStatus.BILLING_FAILURE for
failure types or SubscriptionModel.ReratingStatus.RESTORATION_SUCCESS or
SubscriptionModel.ReratingStatus.RERATING_SUCCESS for success types. |
void |
setReratingLockCode(java.lang.String reratingLockCode)
Sets the code of the rerating operation that has locked this subscription. |
void |
setResumptionDate(java.util.Date resumptionDate)
Sets the resumption date of this subscription. |
void |
setSubscriberAccountCode(java.lang.String subscriberAccountCode)
Sets the code of the subscriber account for this subscription. |
void |
setSubscriberAccountServiceProvider(java.lang.String subscriberAccountServiceProvider)
Sets the service provider of the subscriber account for this subscription. |
void |
setSuspensionDate(java.util.Date suspensionDate)
Sets the suspension date of this subscription. |
void |
setType(SubscriptionModel.SubscriptionType type)
Sets the subscription to online,
hybrid or offline. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int ACTIVE_STATUS
public static final int LOCKED_STATUS
public static final int CLOSED_STATUS
| Constructor Detail |
|---|
public SubscriptionModel()
| Method Detail |
|---|
public SubscriptionModel getParent()
setParent(SubscriptionModel)public void setParent(SubscriptionModel parent)
parent - the parent of subscriptiongetParent()public java.lang.String getCode()
setCode(String)public void setCode(java.lang.String code)
code - the code of subscriptiongetCode()public java.lang.String getReference()
setReference(String)public void setReference(java.lang.String reference)
reference - the reference of subscriptiongetReference()public java.lang.String getSubscriberAccountCode()
public void setSubscriberAccountCode(java.lang.String subscriberAccountCode)
subscriberAccountCode - The code of the subscriber account for this subscription.public java.lang.String getSubscriberAccountServiceProvider()
public void setSubscriberAccountServiceProvider(java.lang.String subscriberAccountServiceProvider)
subscriberAccountServiceProvider - The subscriber account service provider for this subscription.public java.lang.String getOfferCode()
setOfferCode(String)public void setOfferCode(java.lang.String offerCode)
offerCode - the codegetOfferCode()public java.lang.String getOfferConditionCode()
setOfferConditionCode(String)public void setOfferConditionCode(java.lang.String offerConditionCode)
offerConditionCode - the code of the offer conditiongetOfferConditionCode()public java.lang.String getReratingLockCode()
offline subscription only. The lock code corresponds to
the rerating operation identifier.
public void setReratingLockCode(java.lang.String reratingLockCode)
UnlockSubscriptionOp instead.
reratingLockCode - the code of the rerating operation that has locked this subscriptionpublic java.lang.String getBatchRatingGroupCode()
null, this subscription is online.
public void setBatchRatingGroupCode(java.lang.String batchRatingGroupCode)
null if subscription is online.
batchRatingGroupCode - the batch rating group codepublic SubscriptionModel.SubscriptionType getType()
online,
hybrid or offline
online,
hybrid or offlinepublic void setType(SubscriptionModel.SubscriptionType type)
online,
hybrid or offline.
The default value is hybrid.
type - must be one of the values online,
hybrid or offlinepublic SubscriptionModel.ReratingStatus getReratingLastStatus()
SubscriptionModel.ReratingStatus.ALREADY_LOCKED_FAILURE,
SubscriptionModel.ReratingStatus.COUNTER_RESTORATION_FAILURE,
SubscriptionModel.ReratingStatus.BART_RESTORATION_FAILURE or SubscriptionModel.ReratingStatus.BILLING_FAILURE for
failure types or SubscriptionModel.ReratingStatus.RESTORATION_SUCCESS or
SubscriptionModel.ReratingStatus.RERATING_SUCCESS for success types.
in order to get the associated rerating operation code,
setReratingLastStatus(ReratingStatus)public void setReratingLastStatus(SubscriptionModel.ReratingStatus reratingLastStatus)
SubscriptionModel.ReratingStatus.ALREADY_LOCKED_FAILURE, SubscriptionModel.ReratingStatus.COUNTER_RESTORATION_FAILURE,
SubscriptionModel.ReratingStatus.BART_RESTORATION_FAILURE or SubscriptionModel.ReratingStatus.BILLING_FAILURE for
failure types or SubscriptionModel.ReratingStatus.RESTORATION_SUCCESS or
SubscriptionModel.ReratingStatus.RERATING_SUCCESS for success types.
reratingLastStatus - the rerating state of the subscriptiongetReratingLastStatus()public java.util.Date getEffective()
setEffective(Date)public void setEffective(java.util.Date effective)
effective - the effective date of the subscriptiongetEffective()public java.util.Date getExpiration()
setExpiration(Date)public void setExpiration(java.util.Date expiration)
expiration - the expiration date of the subscriptiongetExpiration()public java.util.Date getLastSnapshotDate()
setLastSnapshotDate(Date)public void setLastSnapshotDate(java.util.Date lastSnapshotDate)
lastSnapshotDate - the snapshot date of the subscriptiongetLastSnapshotDate()public java.lang.String getReratingLastCode()
setReratingLastCode(String),
in order to get the associated rerating statuspublic void setReratingLastCode(java.lang.String reratingLastCode)
reratingLastCode - the last rerating operation code of the subscriptiongetReratingLastCode()public java.util.Date getPriceFreezeEffective()
setPriceFreezeEffective(Date)public void setPriceFreezeEffective(java.util.Date priceFreezeEffective)
priceFreezeEffective - the priceFreeze effective date of the subscriptiongetPriceFreezeEffective()public java.util.Date getPriceFreezeExpiration()
setPriceFreezeExpiration(Date)public void setPriceFreezeExpiration(java.util.Date priceFreezeExpiration)
priceFreezeExpiration - the priceFreeze expiration date of the subscriptiongetPriceFreezeExpiration()public java.util.Date getCommitmentExpiration()
setCommitmentExpiration(Date)public void setCommitmentExpiration(java.util.Date commitmentExpiration)
commitmentExpiration - the commitmentExpiration date of the subscriptiongetCommitmentExpiration()public java.util.Date getSuspensionDate()
setSuspensionDate(Date)public void setSuspensionDate(java.util.Date suspensionDate)
suspensionDate - the suspension date of the subscriptiongetSuspensionDate()public java.util.Date getResumptionDate()
setResumptionDate(Date)public void setResumptionDate(java.util.Date resumptionDate)
resumptionDate - the resumption date of the subscriptiongetResumptionDate()public java.util.Date getCancellationDate()
setCancellationDate(Date)public void setCancellationDate(java.util.Date cancellationDate)
cancellationDate - the cancellation date of the subscriptiongetCancellationDate()public boolean isOverrideDependencies()
public void setOverrideDependencies(boolean override)
override - true if the subscription overrides the charge dependencies of the offer, false otherwise.public java.util.Vector<SubscriptionModel> getSubscriptions()
subscriptions.public java.util.Vector<ChargeActivationModel> getChargeActivations()
charge activations.public java.util.Vector<AdditionalInfoModel> getAdditionalInfos()
infos.public java.util.Vector<CounterModel> getCounters()
CounterModel.
public ChronologyModel getContextChronology()
subscriptionContext in a Chronology.public void setContext(SubscriptionContextModel context)
context - the context of this subscription.public SubscriptionContextModel getContext()
public void setAttributes(XMLAttributes atts)
XMLMarshallable
setAttributes in interface XMLMarshallableatts - the XML attributes of the current tag.
public void addChild(java.lang.String name,
XMLMarshallable child)
XMLMarshallablechild represents
the marshallable object to be added into the content tree.
addChild in interface XMLMarshallablename - the name of tag for the child.child - the child to be added.public void addCharacterData(java.lang.String cData)
XMLMarshallable
addCharacterData in interface XMLMarshallablecData - the character data to be added.public void marshal(XMLOutputter output)
XMLMarshallable
marshal in interface XMLMarshallableoutput - the XML output to marshall the object into.public void removeSubscription(SubscriptionModel sub)
public void addSubscription(SubscriptionModel sub)
public void addChargeActivation(ChargeActivationModel activation)
public void addChargeActivation(ChargeActivationModel activation,
boolean generateSubCode)
public java.util.Vector<ChargeActivationModel> retrieveAllCharges()
ChargeActivationModel.public java.util.Vector<SubscriptionModel> retrieveAllSubscriptions()
SubscriptionModel.public java.util.Vector<ChargeActivationModel> retrieveInvalidChargeSubCodes()
ChargeActivationModel.
|
SAP CC 1.0
API 4.2 (Core) |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2
(c) Copyright 2009 SAP AG. All rights reserved.