Package com.highdeal.admin.hci
Class SetStandbyStatusOp
java.lang.Object
com.highdeal.admin.hci.SetStandbyStatusOp
- All Implemented Interfaces:
MessageOperation,XMLMarshallable
This operation allows to set or unset the standby status for a set of Core Server instances.
Operation Failure Exceptions
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
<xs:element name="setStandbyStatus">
<xs:complexType>
<xs:sequence>
<xs:element ref="standbyInstance" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</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 | No | No | No | No | Yes |
Audit Domain
This operation is audited by the system as part of the audit domain: ADMINISTRATION. 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.voidaddStandbyInstance(StandbyInstance standbyInstance) Adds aninstanceto the list of instances for which standby status must be changed.getName()Gets the XML name of the service operation.Gets the list ofinstancesfor which standby status must be changed.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.
-
Field Details
-
OPERATION_NAME
The XML element name of the operation.- See Also:
-
-
Constructor Details
-
SetStandbyStatusOp
public SetStandbyStatusOp()
-
-
Method Details
-
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
-
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
-
addCharacterData
Description copied from interface:XMLMarshallableAdds character data to the content element.- Specified by:
addCharacterDatain interfaceXMLMarshallable- Parameters:
cData- The character data 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
-
getName
Description copied from interface:MessageOperationGets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal theJava objectrepresenting an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.Example
activateAllping
- Specified by:
getNamein interfaceMessageOperation- Returns:
- The technical name of the HCI operation
-
getStandbyInstanceList
Gets the list ofinstancesfor which standby status must be changed.- Returns:
- the list of
instancesfor which standby status must be changed
-
addStandbyInstance
Adds aninstanceto the list of instances for which standby status must be changed.- Parameters:
standbyInstance- aninstance
-