Package com.highdeal.admin.hci
Class SetParameterValueOp
java.lang.Object
com.highdeal.admin.hci.ParameterOperation
com.highdeal.admin.hci.SetParameterValueOp
- All Implemented Interfaces:
MessageOperation,XMLMarshallable
This operation allows you to set up an SAP CC system parameter to a specified value.
Operation Result
SetParameterValueResult Operation Failure Exceptions
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
<xs:element name="setParameterValue">
<xs:complexType>
<xs:attribute name="parameterName" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="value">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="1024"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="scope">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="PERSISTENT"/>
<xs:enumeration value="MEMORY"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</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 | Yes | Yes | Yes | Yes | Yes | Yes |
Audit Domain
This operation is audited by the system as part of the audit domain: ADMINISTRATION. Consult the IT administrator.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe XML tag name of this service operation: SetParameterValueOpFields inherited from class com.highdeal.admin.hci.ParameterOperation
PARAM_NAME, SCOPE, VALUE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCharacterData(String cData) Adds string data to this operation.voidaddChild(String tagName, XMLMarshallable child) Adds a child tag to this operation.getName()Returns the name of the operation, that is "setParameterValue".voidmarshal(XMLOutputter output) Writes the operation XML data to the given output.voidsetAttributes(XMLAttributes atts) Sets the operation attributes from theXMLAttributes.Methods inherited from class com.highdeal.admin.hci.ParameterOperation
getParameterName, getScope, getValue, isMemoryScope, isPersistentScope, setParameterName, setScope, setValue
-
Field Details
-
OPERATION_NAME
The XML tag name of this service operation: SetParameterValueOp- See Also:
-
-
Constructor Details
-
SetParameterValueOp
public SetParameterValueOp()
-
-
Method Details
-
getName
Returns the name of the operation, that is "setParameterValue".- Returns:
- "setParameterValue"
-
setAttributes
Sets the operation attributes from theXMLAttributes.- Parameters:
atts- TheXMLAttributescontaining the data
-
addCharacterData
Adds string data to this operation. This data is ignored for this operation.- Parameters:
cData- The character data to add to the operation
-
addChild
Adds a child tag to this operation. For this operation, the child must be a.ParameterModel- Parameters:
tagName- The name of the tagchild- TheXMLMarshallablechild to add
-
marshal
Writes the operation XML data to the given output.- Parameters:
output- TheXMLOutputterto write into
-