com.highdeal.bart.hci

Class AsyncRunRatingSessionOp

java.lang.Object

com.highdeal.bart.hci.AsyncRunRatingSessionOp

All Implemented Interfaces:

com.highdeal.hci.MessageOperation, XMLMarshallable

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

This operation allows to run a rating session in an asynchronous mode.

Contrary to RunRatingSessionOp operation, the operation result AsyncRunRatingSessionResult will be returned once the rating session is started. No other result operation will be returned.

Operation Failure Exception

InvalidRatingSessionException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="asyncRunRatingSession">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="rating" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
AsyncRunRatingSessionOp() Builds an empty operation.

Method Summary

Modifier and Type	Method and Description
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.String	getName() Gets the name.
RatingSessionModel	getRatingSession() Gets the rating session to run.
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	setRatingSession(RatingSessionModel session) Sets the rating session to run.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncRunRatingSessionOp

public AsyncRunRatingSessionOp()

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.

getRatingSession

public RatingSessionModel getRatingSession()

Gets the rating session to run.

Returns:

the rating session model.

setRatingSession

public void setRatingSession(RatingSessionModel session)

Sets the rating session to run.

Parameters:

session - the rating session to run

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