Package 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 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 Exceptions

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 Details

    • InterruptRatingSessionOp

      public InterruptRatingSessionOp()
      Builds an empty operation.

  • Method Details

    • getName

      public String getName()
      Gets the name.
      Specified by:
      getName in interface com.highdeal.hci.MessageOperation
      Returns:
      the name.

    • getSessionID

      public Long getSessionID()
      Gets the rating session id to interrupt.
      Returns:
      the rating session unique ID.

    • setSessionID

      public void setSessionID(Long sessionID)
      Sets the rating session id to interrupt.

    • getBatchRatingGroupId

      public Integer getBatchRatingGroupId()
      Gets the batch rating group Id to interrupt.

    • setBatchRatingGroupId

      public void setBatchRatingGroupId(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(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