StopReratingSessionOp (SAP CC 4.1 Java APIs (Core Library))

java.lang.Object
- com.highdeal.pnr.hci.StopReratingSessionOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable
```
public class StopReratingSessionOp
extends Object
implements MessageOperation
```
This operation stops a given rerating session.
The rerating session is specified by its rerating lock code. This operation throws a RerateBulkException when:
the rerating lock code isn't specified in the operation. The reason code of the exception is 'INVALID'
No rerating session was found from the given rerating lock code. The reason code of the exception is "DOES_NOT_EXIST'

Operation Result

StopReratingSessionResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopReratingSession">
  <xs:complexType>
    <xs:attribute name="reratingLockCode" type="xs:string" 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:

Edition	Final Target Instances
Edition	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	Yes	No	No	No	No

Audit Domain

This operation is audited as part of the audit domain ADMINISTRATION

Field Summary

Fields
Modifier and Type Field and Description

static String OPERATION_NAME

Fields
Modifier and Type	Field and Description
`static String`	`OPERATION_NAME`

Constructor Summary

Constructors
Constructor and Description

StopReratingSessionOp()
Builds an empty operation.

Constructors
Constructor and Description
`StopReratingSessionOp()` Builds an empty operation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCharacterData(String cData)` Adds character data to the content element.
`void`	`addChild(String tagName, XMLMarshallable child)` Adds a child to the object, the `child` representing the marshallable object which must be added to the element.
`String`	`getName()` Gets the XML name of the service operation.
`String`	`getReratingLockCode()`
`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.
`void`	`setReratingLockCode(String reratingLockCode)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPERATION_NAME
```
public static final String OPERATION_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StopReratingSessionOp
```
public StopReratingSessionOp()
```
    Builds an empty operation.
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: MessageOperation
    Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing 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
    
    activateAll
    ping
    Specified by:
    
    getName in interface MessageOperation
    
    Returns:
    
    The technical name of the HCI operation
  - 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
  - getReratingLockCode
```
public String getReratingLockCode()
```
    Returns:
    
    the reratingLockCode
  - setReratingLockCode
```
public void setReratingLockCode(String reratingLockCode)
```
    Parameters:
    
    reratingLockCode - the reratingLockCode to set

Class StopReratingSessionOp

Operation Result

Operation Failure Exceptions

XML API for HCI

Operation Availability

Audit Domain

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPERATION_NAME

Constructor Detail

StopReratingSessionOp

Method Detail

getName

setAttributes

addCharacterData

addChild

marshal

getReratingLockCode

setReratingLockCode