com.highdeal.admin.hci

Class SearchUserSessionResult.UserSessionModel

java.lang.Object

com.highdeal.admin.hci.SearchUserSessionResult.UserSessionModel

All Implemented Interfaces:

XMLMarshallable

Enclosing class:

SearchUserSessionResult

public static class SearchUserSessionResult.UserSessionModel
extends java.lang.Object
implements XMLMarshallable

This Java class represents a user session.

A user session contains the following information:

• sessionId: the identifier of the user session
• userLogin: the logon of the SAP CC user associated to this user session
• toolName: the name of the tool associated to this user session
• creationDate: the creation date of the user session
• lastActivityDate: the date of the last activity on the user session

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="userSession">
   <xs:complexType>
     <xs:attribute name="sessionId" type="xs:string" />
     <xs:attribute name="userLogin" type="xs:string" />
     <xs:attribute name="toolName" type="xs:string" />
     <xs:attribute name="creationDate" type="xs:dateTime" />
     <xs:attribute name="lastActivityDate" type="xs:dateTime" />
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME The XML tag name of this data model: TAG_NAME

Constructor Summary

Constructors

Constructor and Description
UserSessionModel() Builds an empty UserSessionModel.

Method Summary

Modifier and Type	Method and Description
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.util.Date	getCreationDate() Gets the creation date of the user session.
java.util.Date	getLastActivityDate() Gets the date of the last activity on the user session.
java.lang.String	getSessionId() Gets the identifier of the user session.
java.lang.String	getToolName() Gets the name of the user interface associated to the user session.
java.lang.String	getUserLogin() Gets the logon of the SAP CC user associated to the 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	setCreationDate(java.util.Date creationDate) Sets the creation date of the user session.
void	setLastActivityDate(java.util.Date lastActivity) Sets the date of the last activity on the user session.
void	setSessionId(java.lang.String sessionId) Sets the identifier of the user session.
void	setToolName(java.lang.String toolName) Sets the name of the tool associated to the user session.
void	setUserLogin(java.lang.String userLogin) Sets the logon of the SAP CC user associated to the user session.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

The XML tag name of this data model: TAG_NAME

See Also:

Constant Field Values

Constructor Detail

UserSessionModel

public UserSessionModel()

Builds an empty UserSessionModel.

Method Detail

getSessionId

public java.lang.String getSessionId()

Gets the identifier of the user session.

Returns:

The identifier of the user session

setSessionId

public void setSessionId(java.lang.String sessionId)

Sets the identifier of the user session.

Parameters:

sessionId - The identifier of the user session

getUserLogin

public java.lang.String getUserLogin()

Gets the logon of the SAP CC user associated to the user session.

Returns:

The logon of the user associated to the user session

setUserLogin

public void setUserLogin(java.lang.String userLogin)

Sets the logon of the SAP CC user associated to the user session.

Parameters:

userLogin - The logon of the user associated to the user session

getToolName

public java.lang.String getToolName()

Gets the name of the user interface associated to the user session.

Returns:

The name of the tool associated to the user session

setToolName

public void setToolName(java.lang.String toolName)

Sets the name of the tool associated to the user session.

Parameters:

toolName - The name of the tool associated to the user session

getCreationDate

public java.util.Date getCreationDate()

Gets the creation date of the user session.

Returns:

The creation date of the user session

setCreationDate

public void setCreationDate(java.util.Date creationDate)

Sets the creation date of the user session.

Parameters:

creationDate - The creation date of the user session

getLastActivityDate

public java.util.Date getLastActivityDate()

Gets the date of the last activity on the user session.

Returns:

The date of the last activity on the user session

setLastActivityDate

public void setLastActivityDate(java.util.Date lastActivity)

Sets the date of the last activity on the user session.

Parameters:

lastActivity - The date of the last activity on the 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