com.highdeal.admin.hci
Class StopActivationOp

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

public class StopActivationOp
extends java.lang.Object
implements MessageOperation

This operation allows you to stop a running activation process on subscriptions originally triggered by using the Activate All operation.

The SAP CC system receives this Stop Activation operation; It dispatches the operation by informing all the rater instances that they have to terminate the activation after their current subscription activations and this in a asynchronous ways. It means that the stop operation returns even if the rater instances are still finishing their current activation work. If you request immediately a new activation operation after the execution of stop activation operation request, there is a remote possibility of receiving an ActivateException with the reason activationProcessAlreadyRunning because the SAP CC system has not smoothly terminated the previous activation process.

Normally, this operation should not take more than few seconds. However, if the server side cannot reach all the rater instances or if the rater instances do not send an acknowledge before a while of 30 seconds, the operation will be aborted and an INCOMPLETE_STATUS will be returned in the Stop Activation Result message.

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

Operation Result

StopActivationResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopActivation">
 </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

Field Summary
static java.lang.String OPERATION_NAME
          The XML tag nale of this service operation: "stopActivation"
 
Constructor Summary
StopActivationOp()
          Constructs an empty StopActivation 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 object, the child representing the marshallable object which must be added to the element.
 java.lang.String getName()
          Returns the name of this operation is "stopActivation".
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, including its children.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME
The XML tag nale of this service operation: "stopActivation"

See Also:
Constant Field Values
Constructor Detail

StopActivationOp

public StopActivationOp()
Constructs an empty StopActivation Operation.

Method Detail

getName

public java.lang.String getName()
Returns the name of this operation is "stopActivation".

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

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(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 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

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)