Package com.highdeal.admin.hci

Class DeleteUserSessionResult

java.lang.Object
com.highdeal.admin.hci.DeleteUserSessionResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class DeleteUserSessionResult extends Object implements OperationResult
This operation result is sent in response to a Delete User Session operation when the user session has been successfully deleted.

The identifier of the deleted session is stored in the sessionId attribute.

Operation Request

DeleteUserSessionOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="deleteUserSessionResult">
   <xs:complexType>
     <xs:attribute name="count" type="xs:integer" use="required"/>
     <xs:attribute name="sessionId" type="xs:string" />
   </xs:complexType>
 </xs:element>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    OPERATION_NAME
    The XML name of the operation result: "deleteUserSessionResult"

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeleteUserSessionResult()
    Builds an empty DeleteUserSessionResult.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCharacterData(String data)
    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.
    int
    getCount()
    Gets the count of the deleted user session.
    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.
    String
    getSessionId()
    Gets the identifier of the deleted user session.
    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
    setCount(int count)
    Sets the count of the deleted user session.
    void
    setSessionId(String sessionId)
    Sets the identifier of the deleted user session.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML name of the operation result: "deleteUserSessionResult"
      See Also:

  • Constructor Details

    • DeleteUserSessionResult

      public DeleteUserSessionResult()
      Builds an empty DeleteUserSessionResult.

  • Method Details

    • getCount

      public int getCount()
      Gets the count of the deleted user session.
      Returns:
      The count of the deleted user session

    • setCount

      public void setCount(int count)
      Sets the count of the deleted user session.
      Parameters:
      count - The count of the deleted user session

    • getSessionId

      public String getSessionId()
      Gets the identifier of the deleted user session.
      Returns:
      The identifier of the deleted user session

    • setSessionId

      public void setSessionId(String sessionId)
      Sets the identifier of the deleted user session.
      Parameters:
      sessionId - The identifier of the deleted user session

    • getOperandReference

      public 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

    • addCharacterData

      public void addCharacterData(String data)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      data - 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

    • 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