com.highdeal.bart.hci
Class InterruptRatingSessionOp

java.lang.Object
  com.highdeal.bart.hci.InterruptRatingSessionOp

All Implemented Interfaces:

com.highdeal.hci.MessageOperation, XMLMarshallable

public class InterruptRatingSessionOp
extends java.lang.Object
implements com.highdeal.hci.MessageOperation

This operation allows to interrupt a rating session based on a unique sessionID or a unique batch rating group Id. If sessionID is not null, it is used instead of batch rating group Id. If sessionID is null and batch rating group Id is not null, it is used instead of session id.

Operation Failure Exception

InvalidRatingSessionException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="interruptRatingSession">
   <xs:complexType>
     <xs:attribute name="sessionID" type="xs:string"/>
     <xs:attribute name="batchRatingGroupId" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

InterruptRatingSessionOp()
Builds an empty 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.Integer	getBatchRatingGroupId() Gets the batch rating group Id to interrupt.
java.lang.String	getName() Gets the name.
java.lang.Long	getSessionID() Gets the rating session id to interrupt.
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	setBatchRatingGroupId(java.lang.Integer batchRatingGroupId) Sets the batch rating group Id to interrupt.
void	setSessionID(java.lang.Long sessionID) Sets the rating session id to interrupt.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InterruptRatingSessionOp

public InterruptRatingSessionOp()

Builds an empty operation.

Method Detail

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface com.highdeal.hci.MessageOperation

Returns:

the name.

getSessionID

public java.lang.Long getSessionID()

Gets the rating session id to interrupt.

Returns:

the rating session unique ID.

setSessionID

public void setSessionID(java.lang.Long sessionID)

Sets the rating session id to interrupt.

getBatchRatingGroupId

public java.lang.Integer getBatchRatingGroupId()

Gets the batch rating group Id to interrupt.

setBatchRatingGroupId

public void setBatchRatingGroupId(java.lang.Integer batchRatingGroupId)

Sets the batch rating group Id to interrupt.

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