Class DeleteSubscriptionOp
- All Implemented Interfaces:
MessageOperation,XMLMarshallable
subscription in the customer master data of the service provider.
Note
This operation may conflict with the prerating feature. This may lead to inconsistency if the deletion
concerns a subscription containing unresolved pre-ratings, or unstopped sessions.
In that case, post-ratings will fail as for session update and stop.
To prevent from that, the user is warned when he/she tries to delete such a subscription.
But if the user considers the deletion as safe, he/she can force it (using the ignorePrerating parameter
and/or using the ignorePendingSession parameter).
Operation Result
DeleteSubscriptionResult Operation Failure Exceptions
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
<xs:element name="deleteSubscription">
<xs:complexType>
<xs:attribute name="code" type="xs:string"/>
<xs:attribute name="ignorePreRating" type="xs:boolean" default="false"/>
<xs:attribute name="ignorePendingSession" 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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCharacterData(String cData) Adds character data to the content element.voidaddChild(String tagName, XMLMarshallable child) Adds a child to the object, thechildrepresenting the marshallable object which must be added to the element.getCode()Returns the code of the subscription to be deleted.getName()Returns the name of the operation, that is "deleteSubscription".booleanGets the ignorePendingSession attribute.booleanGets the ignorePreRating attribute.voidmarshal(XMLOutputter output) Gives an XML representation of this object, including its children.voidsetAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.voidSets the code of the subscription to be deleted.voidsetIgnorePendingSession(boolean ignorePendingSession) Sets the ignorePendingSession attribute.voidsetIgnorePreRating(boolean ignorePreRating) Sets the ignorePreRating attribute.
-
Field Details
-
OPERATION_NAME
- See Also:
-
DEFAULT_IGNORE_PENDING_SESSION
public static final boolean DEFAULT_IGNORE_PENDING_SESSION- See Also:
-
-
Constructor Details
-
DeleteSubscriptionOp
public DeleteSubscriptionOp()Builds an empty operation.
-
-
Method Details
-
getName
Returns the name of the operation, that is "deleteSubscription".- Specified by:
getNamein interfaceMessageOperation- Returns:
- "deleteSubscription"
-
getCode
Returns the code of the subscription to be deleted.- Returns:
- The code of the subscription to be deleted
-
setCode
Sets the code of the subscription to be deleted.- Parameters:
code- The code of the subscription to be deleted
-
isIgnorePreRating
public boolean isIgnorePreRating()Gets the ignorePreRating attribute.- Returns:
- The ignorePreRating value
-
setIgnorePreRating
public void setIgnorePreRating(boolean ignorePreRating) Sets the ignorePreRating attribute.- Parameters:
ignorePreRating-
-
isIgnorePendingSession
public boolean isIgnorePendingSession()Gets the ignorePendingSession attribute.- Returns:
- The ignorePendingSession value
-
setIgnorePendingSession
public void setIgnorePendingSession(boolean ignorePendingSession) Sets the ignorePendingSession attribute.- Parameters:
ignorePendingSession-
-
setAttributes
Description copied from interface:XMLMarshallableSets the attributes of the XML representation of the element being processed.- Specified by:
setAttributesin interfaceXMLMarshallable- Parameters:
atts- TheXML attributesof the current element
-
addCharacterData
Description copied from interface:XMLMarshallableAdds character data to the content element.- Specified by:
addCharacterDatain interfaceXMLMarshallable- Parameters:
cData- The character data to be added
-
addChild
Description copied from interface:XMLMarshallableAdds a child to the object, thechildrepresenting the marshallable object which must be added to the element.- Specified by:
addChildin interfaceXMLMarshallable- Parameters:
tagName- The name of tag for the childchild- The child to be added
-
marshal
Description copied from interface:XMLMarshallableGives an XML representation of this object, including its children.- Specified by:
marshalin interfaceXMLMarshallable- Parameters:
output- TheXML outputto marshal the object into
-