Package com.highdeal.admin.hci

Class StopCleanupOp

java.lang.Object
com.highdeal.admin.hci.StopCleanupOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class StopCleanupOp extends Object implements MessageOperation
This operation allows you to stop a running cleanup. This operation sends a message to all the rater instances for stopping the current cleanup running on each of them. No parameter is required for this operation.

Normally, this operation should not take more than few seconds. However, if the server side cannot reach all the raters or if the raters don't send an acknowledge before a while of 30 seconds, the operation will be aborted and an "incomplete" status will be returned into the StopCleanupResult.

In any case, (even if the returned status is set to "incomplete") this operation will release the cleanup running mutex which forbids to execute 2 cleanup process in a concurrent way.

This operation returns a StopCleanupResult which will contain an execution status of cleaned up subscriptions.

Operation Result

StopCleanupResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopCleanup">
 </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: "stopCleanup"
      See Also:

  • Constructor Details

    • StopCleanupOp

      public StopCleanupOp()
      Constructs an empty StopCleanup Operation.

  • Method Details

    • getName

      public String getName()
      The name of this operation is "stopleanup".
      Specified by:
      getName in interface MessageOperation
      Returns:
      "stopCleanup"

    • 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