com.highdeal.hci
Class DisconnectUserResult

java.lang.Object
  com.highdeal.hci.DisconnectUserResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class DisconnectUserResult
extends java.lang.Object
implements OperationResult

This result is sent in response to the Disconnect User operation; It contains the identifier of the SAP CC user session that has been deleted.

Operation Request

DisconnectUserOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="disconnectUserResult">
   <xs:complexType>
     <xs:attribute name="sessionId" type="xs:string" />
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String

OPERATION_NAME The XML name of the result: "disconnectUserResult"

Constructor Summary

DisconnectUserResult()
Builds an empty DisconnectUserResult.

Method Summary

void	addCharacterData(java.lang.String data) 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	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	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	setSessionId(java.lang.String sessionId) Sets the identifier of the deleted user session.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML name of the result: "disconnectUserResult"

See Also:

Constant Field Values

Constructor Detail

DisconnectUserResult

public DisconnectUserResult()

Builds an empty DisconnectUserResult.

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

getSessionId

public java.lang.String getSessionId()

Gets the identifier of the deleted user session.

Returns:

The identifier of the deleted user session

setSessionId

public void setSessionId(java.lang.String sessionId)

Sets the identifier of the deleted user session.

Parameters:

sessionId - The identifier of the deleted user session

addCharacterData

public void addCharacterData(java.lang.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(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

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