com.highdeal.pnr.hci
Class GetCurrentReratingSessionStatusResult

java.lang.Object
  extended by com.highdeal.pnr.hci.GetCurrentReratingSessionStatusResult
All Implemented Interfaces:
OperationResult, XMLMarshallable

public class GetCurrentReratingSessionStatusResult
extends java.lang.Object
implements OperationResult

This class gives the possibility to retrieve the result of a Get Current Rerating Session Status operation; If no rerating session is in progress, the result of the last rerating session is returned.

Operation Request

GetCurrentReratingSessionStatusOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getCurrentReratingSessionStatusResult">
  <xs:complexType>
    <xs:attribute name="reratingLockCode" type="xs:string"/>
    <xs:attribute name="inProgress" type="xs:boolean"/>
    <xs:attribute name="batchGroupReratedCount" type="xs:integer"/>
    <xs:attribute name="batchGroupToRerateCount" type="xs:integer"/>
    <xs:attribute name="batchGroupReratedDaysCount" type="xs:integer"/>
    <xs:attribute name="batchGroupDaysToRerateCount" type="xs:integer"/>
    <xs:attribute name="batchGroupSubscriptionLockedCount" type="xs:integer"/>
    <xs:attribute name="batchGroupSubscriptionLockErrorCount" type="xs:integer"/>
    <xs:attribute name="batchGroupSubscriptionUnlockedCount" type="xs:integer"/>
    <xs:attribute name="batchGroupSubscriptionUnlockErrorCount" type="xs:integer"/>
    <xs:attribute name="batchGroupSubscriptionToRerateCount" type="xs:integer"/>
    <xs:attribute name="subscriptionErrorCount" type="xs:integer"/>
    <xs:attribute name="subscriptionToRerateCount" type="xs:integer"/>
    <xs:attribute name="adaptedSubscriptionCount" type="xs:integer"/>
  </xs:complexType>
 </xs:element>


Field Summary
static java.lang.String RESULT_NAME
          The name of the marshallable result: "getCurrentReratingSessionStatusResult"
 
Constructor Summary
GetCurrentReratingSessionStatusResult()
          Builds an empty operation result.
GetCurrentReratingSessionStatusResult(java.lang.String lockCode, boolean inProgress, int batchGroupToRerateCount, int batchGroupReratedCount, int subscriptionToRerateCount, int adaptedSubscriptionCount, int batchGroupReratedDaysCount, int batchGroupDaysToRerateCount, int batchGroupSubscriptionLockedCount, int batchGroupSubscriptionLockErrorCount, int batchGroupSubscriptionUnlockedCount, int batchGroupSubscriptionUnlockErrorCount, int batchGroupSubscriptionToRerateCount, int subscriptionErrorCount)
          Builds a result with all its details.
 
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.
 int getAdaptedSubscriptionCount()
           
 int getBatchGroupDaysToRerateCount()
           
 int getBatchGroupReratedCount()
           
 int getBatchGroupReratedDaysCount()
           
 int getBatchGroupSubscriptionLockedCount()
           
 int getBatchGroupSubscriptionLockErrorCount()
           
 int getBatchGroupSubscriptionToRerateCount()
           
 int getBatchGroupSubscriptionUnlockedCount()
           
 int getBatchGroupSubscriptionUnlockErrorCount()
           
 int getBatchGroupToRerateCount()
           
 java.lang.String getOperandReference()
          Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
 java.lang.String getReratingLockCode()
           
 int getSubscriptionErrorCount()
           
 int getSubscriptionToRerateCount()
           
 boolean isInProgress()
           
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, including its children.
 void setAdaptedSubscriptionCount(int adaptedSubscriptionCount)
           
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 void setBatchGroupDaysToRerateCount(int batchGroupDaysToRerateCount)
           
 void setBatchGroupReratedCount(int batchGroupReratedCount)
           
 void setBatchGroupReratedDaysCount(int batchGroupReratedDaysCount)
           
 void setBatchGroupSubscriptionLockedCount(int batchGroupSubscriptionLockedCount)
           
 void setBatchGroupSubscriptionLockErrorCount(int batchGroupSubscriptionLockErrorCount)
           
 void setBatchGroupSubscriptionToRerateCount(int batchGroupSubscriptionToRerateCount)
           
 void setBatchGroupSubscriptionUnlockedCount(int batchGroupSubscriptionUnlockedCount)
           
 void setBatchGroupSubscriptionUnlockErrorCount(int batchGroupSubscriptionUnlockErrorCount)
           
 void setBatchGroupToRerateCount(int batchGroupToRerateCount)
           
 void setInProgress(boolean inProgress)
           
 void setReratingLockCode(java.lang.String reratingLockCode)
           
 void setSubscriptionErrorCount(int subscriptionErrorCount)
           
 void setSubscriptionToRerateCount(int subscriptionToRerateCount)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME
The name of the marshallable result: "getCurrentReratingSessionStatusResult"

See Also:
Constant Field Values
Constructor Detail

GetCurrentReratingSessionStatusResult

public GetCurrentReratingSessionStatusResult()
Builds an empty operation result.


GetCurrentReratingSessionStatusResult

public GetCurrentReratingSessionStatusResult(java.lang.String lockCode,
                                             boolean inProgress,
                                             int batchGroupToRerateCount,
                                             int batchGroupReratedCount,
                                             int subscriptionToRerateCount,
                                             int adaptedSubscriptionCount,
                                             int batchGroupReratedDaysCount,
                                             int batchGroupDaysToRerateCount,
                                             int batchGroupSubscriptionLockedCount,
                                             int batchGroupSubscriptionLockErrorCount,
                                             int batchGroupSubscriptionUnlockedCount,
                                             int batchGroupSubscriptionUnlockErrorCount,
                                             int batchGroupSubscriptionToRerateCount,
                                             int subscriptionErrorCount)
Builds a result with all its details.

Parameters:
lockCode - The rerating lock code
inProgress - The state of the rerating session
batchGroupReratedCount - The count of batch groups that have been rerated
batchGroupToRerateCount - The count of batch groups that must be rerated
subscriptionToRerateCount - The count of subscriptions that must be rerated
adaptedSubscriptionCount - The count of subscriptions for which restoration date have been adapted.
batchGroupReratedDaysCount - The count of days rerated in the current batch group
batchGroupDaysToRerateCount - The count of days to rerate in the current batch group
batchGroupSubscriptionLockedCount - The count of subscription locked in the current batch group
batchGroupSubscriptionLockErrorCount - The count of subscription in error during the lock phase in the current batch group
batchGroupSubscriptionUnlockedCount - The count of subscription locked in the current batch group
batchGroupSubscriptionUnlockErrorCount - The count of subscription in error during the unlock phase in the current batch group
batchGroupSubscriptionToRerateCount - The count of subscription to rerate in the current batch group
subscriptionErrorCount - The total count of subscriptions in error
Method Detail

getOperandReference

public java.lang.String getOperandReference()
Description copied from interface: OperationResult
Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:
getOperandReference in interface OperationResult
Returns:
The operand reference of the operation result

getReratingLockCode

public java.lang.String getReratingLockCode()
Returns:
The reratingLockCode

setReratingLockCode

public void setReratingLockCode(java.lang.String reratingLockCode)
Parameters:
reratingLockCode - The reratingLockCode to set

isInProgress

public boolean isInProgress()
Returns:
true if a rerating session is in progress, false otherwise.

setInProgress

public void setInProgress(boolean inProgress)
Parameters:
inProgress - The inProgress to set

getBatchGroupReratedCount

public int getBatchGroupReratedCount()
Returns:
The batchGroupReratedCount

setBatchGroupReratedCount

public void setBatchGroupReratedCount(int batchGroupReratedCount)
Parameters:
batchGroupReratedCount - The batchGroupReratedCount to set

getBatchGroupToRerateCount

public int getBatchGroupToRerateCount()
Returns:
The batchGroupToRerateCount

setBatchGroupToRerateCount

public void setBatchGroupToRerateCount(int batchGroupToRerateCount)
Parameters:
batchGroupToRerateCount - The batchGroupToRerateCount to set

getSubscriptionToRerateCount

public int getSubscriptionToRerateCount()
Returns:
The subscriptionToRerateCount

setSubscriptionToRerateCount

public void setSubscriptionToRerateCount(int subscriptionToRerateCount)
Parameters:
subscriptionToRerateCount - The subscriptionToRerateCount to set

getAdaptedSubscriptionCount

public int getAdaptedSubscriptionCount()
Returns:
the adaptedSubscriptionCount

setAdaptedSubscriptionCount

public void setAdaptedSubscriptionCount(int adaptedSubscriptionCount)
Parameters:
adaptedSubscriptionCount - The adaptedSubscriptionCount to set

getBatchGroupReratedDaysCount

public int getBatchGroupReratedDaysCount()
Returns:
The batchGroupReratedDaysCount

setBatchGroupReratedDaysCount

public void setBatchGroupReratedDaysCount(int batchGroupReratedDaysCount)
Parameters:
batchGroupReratedDaysCount - The batchGroupReratedDaysCount to set

getBatchGroupDaysToRerateCount

public int getBatchGroupDaysToRerateCount()
Returns:
The batchGroupDaysToRerateCount

setBatchGroupDaysToRerateCount

public void setBatchGroupDaysToRerateCount(int batchGroupDaysToRerateCount)
Parameters:
batchGroupDaysToRerateCount - The batchGroupDaysToRerateCount to set

getBatchGroupSubscriptionLockedCount

public int getBatchGroupSubscriptionLockedCount()
Returns:
The batchGroupSubscriptionLockedCount

setBatchGroupSubscriptionLockedCount

public void setBatchGroupSubscriptionLockedCount(int batchGroupSubscriptionLockedCount)
Parameters:
batchGroupSubscriptionLockedCount - The batchGroupSubscriptionLockedCount to set

getBatchGroupSubscriptionLockErrorCount

public int getBatchGroupSubscriptionLockErrorCount()
Returns:
The batchGroupSubscriptionLockErrorCount

setBatchGroupSubscriptionLockErrorCount

public void setBatchGroupSubscriptionLockErrorCount(int batchGroupSubscriptionLockErrorCount)
Parameters:
batchGroupSubscriptionLockErrorCount - The batchGroupSubscriptionLockErrorCount to set

getBatchGroupSubscriptionUnlockedCount

public int getBatchGroupSubscriptionUnlockedCount()
Returns:
The batchGroupSubscriptionUnlockedCount

setBatchGroupSubscriptionUnlockedCount

public void setBatchGroupSubscriptionUnlockedCount(int batchGroupSubscriptionUnlockedCount)
Parameters:
batchGroupSubscriptionUnlockedCount - The batchGroupSubscriptionUnlockedCount to set

getBatchGroupSubscriptionUnlockErrorCount

public int getBatchGroupSubscriptionUnlockErrorCount()
Returns:
The batchGroupSubscriptionUnlockErrorCount

setBatchGroupSubscriptionUnlockErrorCount

public void setBatchGroupSubscriptionUnlockErrorCount(int batchGroupSubscriptionUnlockErrorCount)
Parameters:
batchGroupSubscriptionUnlockErrorCount - The batchGroupSubscriptionUnlockErrorCount to set

getBatchGroupSubscriptionToRerateCount

public int getBatchGroupSubscriptionToRerateCount()
Returns:
The batchGroupSubscriptionToRerateCount

setBatchGroupSubscriptionToRerateCount

public void setBatchGroupSubscriptionToRerateCount(int batchGroupSubscriptionToRerateCount)
Parameters:
batchGroupSubscriptionToRerateCount - The batchGroupSubscriptionToRerateCount to set

getSubscriptionErrorCount

public int getSubscriptionErrorCount()
Returns:
The subscriptionErrorCount

setSubscriptionErrorCount

public void setSubscriptionErrorCount(int subscriptionErrorCount)
Parameters:
subscriptionErrorCount - The subscriptionErrorCount to set

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)