com.sage.orion.sdata.servlet.swtservice
Class UserInfo

java.lang.Object
  com.sage.orion.sdata.servlet.swtservice.UserInfo

public final class UserInfo
extends java.lang.Object

A struct-like class that contains immutable user information for a user signed on to SWT services.

Constructor Summary

UserInfo(java.lang.String id, java.lang.String language, boolean isAdmin, com.sage.accpac.sm.SharedDataSet sharedDataSet)
Constructs an object containing information for a user signed on to SWT services.

Method Summary

java.lang.String	getID() Gets the (non-empty) signed-on user's ID.
java.lang.String	getLanguage() Gets the (non-empty) lower-cased language code (for example, "eng") representing the signed-on user's language.
com.sage.accpac.sm.SharedDataSet	getSharedDataSet() Returns the SharedDataSet in which the user is defined.
boolean	isAdmin() Tells whether the user is an administrator or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInfo

public UserInfo(java.lang.String id,
                java.lang.String language,
                boolean isAdmin,
                com.sage.accpac.sm.SharedDataSet sharedDataSet)

Constructs an object containing information for a user signed on to SWT services.

Parameters:

id - The signed-on user's ID (must be non-empty).

language - The signed-on user's language code (must be non-empty).

isAdmin - Boolean set to TRUE for ADMIN user, FALSE otherwise.

sharedDataSet - The shared data set in which the user is defined

Method Detail

getID

public java.lang.String getID()

Gets the (non-empty) signed-on user's ID.

Returns:

The (non-empty) signed-on user's ID.

getLanguage

public java.lang.String getLanguage()

Gets the (non-empty) lower-cased language code (for example, "eng") representing the signed-on user's language.

Returns:

The (non-empty) lower-cased language code (for example, "eng") representing the signed-on user's language.

isAdmin

public boolean isAdmin()

Tells whether the user is an administrator or not.

Returns:

True is the user is an administrator, false otherwise.

getSharedDataSet

public com.sage.accpac.sm.SharedDataSet getSharedDataSet()

Returns the SharedDataSet in which the user is defined.

Returns:

the SharedDataSet that was provided when the object was created