SAP CC 1.0
API 4.2 (Core)

com.highdeal.pnr.hci
Class DeleteSubscriptionBulkOp

java.lang.Object
  extended by com.highdeal.pnr.hci.DeleteSubscriptionBulkOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable

public class DeleteSubscriptionBulkOp
extends java.lang.Object
implements MessageOperation

This operation allows to do a bulk deletion of subscriptions thanks to a filter selecting entities to be deleted. Deletion can occur only on root subscriptions.

This operation may conflict with the pre-rating feature. This may lead to inconsistency if the deletion concerns at least a subscription containing unresolved pre-ratings. In that case, post-ratings will fail. 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). To improve bulk performance and minimize database locks, this process allows the user to customize some parameters :

Warning: Deletions are not commited in one time. So if targeted subscriptions are rated during bulk process, we can not be sure that subscriptions are still there or not.

See Also :
DeleteSubscriptionBulkResult
Operation Failure Exception :
InvalidSearchException
InvalidDeletionException
ServerFailureException
Operation available with roles :
"admin"


XML Schema Fragment
<xs:element name="deleteSubscriptionBulk">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="subscriptionSearchFilter" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="ignorePreRating" type="xs:string" default="false"/>
     <xs:attribute name="ignorePendingSession" type="xs:string" default="false"/>
   </xs:complexType>
 </xs:element>

Operation availability :
EditionAvailable On:
RaterUpdaterBackupGuiderChargerBulkLoaderBillingAssistantEZTaxer
Ratenoyesnononononono
Chargenoyesnononononono
Billnoyesnononononono
Fullnoyesnononononono

Constructor Summary
DeleteSubscriptionBulkOp()
          Builds an empty operation.
 
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 objects, the child represents the marshallable object to be added into the content tree.
 SubscriptionSearchFilterModel getFilter()
          Gets the subscription filter.
 java.lang.String getName()
          Returns the name of the operation, that is "deleteSubscriptionBulk".
 boolean isIgnorePendingSession()
          Gets the ignorePendingSession attribute.
 boolean isIgnorePreRating()
          Gets the ignorePreRating attribute.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, and of its children.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the tag beeing processed.
 void setFilter(SubscriptionSearchFilterModel filter)
          Sets the subscription filter.
 void setIgnorePendingSession(boolean ignorePendingSession)
          Sets the ignorePendingSession attribute.
 void setIgnorePreRating(boolean ignorePreRating)
          Sets the ignorePreRating attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DeleteSubscriptionBulkOp

public DeleteSubscriptionBulkOp()
Builds an empty operation.

Method Detail

getName

public java.lang.String getName()
Returns the name of the operation, that is "deleteSubscriptionBulk".

Specified by:
getName in interface MessageOperation
Returns:
"deleteSubscriptionBulk"

getFilter

public SubscriptionSearchFilterModel getFilter()
Gets the subscription filter.

Returns:
the subscription filter to apply.

setFilter

public void setFilter(SubscriptionSearchFilterModel filter)
Sets the subscription filter.

Parameters:
filter - the subscription filter to apply.

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

public void setAttributes(XMLAttributes atts)
Description copied from interface: XMLMarshallable
Sets the attributes of the XML representation of the tag beeing processed.

Specified by:
setAttributes in interface XMLMarshallable
Parameters:
atts - the XML attributes of the current tag.

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 objects, the child represents the marshallable object to be added into the content tree.

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, and of its children.

Specified by:
marshal in interface XMLMarshallable
Parameters:
output - the XML output to marshall the object into.

SAP CC 1.0
API 4.2 (Core)


API Reference - July 2009

SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2

(c) Copyright 2009 SAP AG. All rights reserved.