Package com.highdeal.admin.hci

Class PurgeAllowancesOp

java.lang.Object
com.highdeal.admin.hci.PurgeAllowancesOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class PurgeAllowancesOp extends Object implements MessageOperation
FOR INTERNAL USE ONLY - See the Admin+ user interface; This mass operation allows to trigger the Purge Allowances process on all the charging contracts (Concept: provider contracts) in customer master data of a service provider; It contains a date which is used as from date reference to remove allowances.

Operation Result

PurgeAllowancesResult

Related Operation

Consider the Stop Purge Allowances operation
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="purgeAllowances">
   <xs:complexType>
     <xs:attribute name="maxThroughput" type="xs:integer" default="0"/>
     <xs:attribute name="toDate" type="xs:dateTime" use="required"/>
   </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:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeNoNoNoNoNoYes

Audit Domain

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

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML tag name of this service operation: "purgeAllowances"
      See Also:

  • Constructor Details

    • PurgeAllowancesOp

      public PurgeAllowancesOp()
      Constructs an empty PurgeAllowances operation.

  • Method Details

    • getName

      public String getName()
      Returns the name of this operation is OPERATION_NAME.
      Specified by:
      getName in interface MessageOperation
      Returns:
      OPERATION_NAME

    • getToDate

      public Date getToDate()
      Gets the to date for this purge operation.
      Returns:
      The reference date for the purge operation

    • setToDate

      public void setToDate(Date toDate)
      Sets the to date for this purge operation.
      Parameters:
      toDate - The reference date for the purge operation

    • getMaxThroughput

      public int getMaxThroughput()
      Returns the maximum throughput (maximum number of charging contracts with allowances checked per second into each rater instance).
      Returns:
      The maximum throughput

    • setMaxThroughput

      public void setMaxThroughput(int val)
      Sets the maximum throughput. A negative value is considered like 0 (no limitation).
      Parameters:
      val - The value of the maximum throughput allowed

    • 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

    • addCharacterData

      public void addCharacterData(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(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

    • 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

    • isActivateProviderContract

      public boolean isActivateProviderContract()
      Returns:
      The activateProviderContract

    • setActivateProviderContract

      public void setActivateProviderContract(boolean activateProviderContract)
      Parameters:
      activateProviderContract - The activateProviderContract to set