com.tivoli.twg.engine
Class TWGConUser

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGConObject
      extended bycom.tivoli.twg.engine.TWGConUser

public class TWGConUser
extends TWGConObject

Console shadow object for TWGUser


Field Summary
 
Fields inherited from class com.tivoli.twg.engine.TWGConObject
INVALID_OBJECT_ID
 
Constructor Summary
TWGConUser(long obj_id)
          Constructor for TWGConUser with given object ID
 
Method Summary
static boolean currentHasPrivilege(java.lang.String priv_id)
          Test if current user has requested privilege
static TWGConUser getCurrent()
          Get current user
 java.lang.String getDescription()
          Get description string
 java.lang.String getEMail()
          Get user e-mail
 java.lang.String getFullName()
          Get full user name
 LongValueSet getGroupAccessList()
          Get group access list
 java.lang.String getName()
          Get account name
 java.lang.String getPager()
          Get pager data
 StringValueSet getPrivs()
          Get privilege token set for user
 LongValueSet getTaskAccessList()
          Get task access list
 boolean hasPrivilege(java.lang.String priv_id)
          Test if user has given privilege
 boolean isGroupLimited()
          Is user limited to a specific set of groups
 boolean isReadOnlyGroupAccess()
          Is user limited to read-only access to groups
 boolean isTaskLimited()
          Is user limited to a specific set of tasks
 java.lang.String toString()
          Generate string representation of object
 void UpdateUsingShadowRecord(byte[] buf, int rec_off, int rec_len)
          Update object using shadow record created by the the engine object which is matched with this class.
 
Methods inherited from class com.tivoli.twg.engine.TWGConObject
AllObjects, AllObjects, Delete, DeleteObjects, DeregisterListener, FindObject, getBaseClassName, LookUpShadowClass, ObjectID, ProcessUpdateRequest, RegisterListener, SetObjectID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TWGConUser

public TWGConUser(long obj_id)
           throws DuplicateObjectIDException
Constructor for TWGConUser with given object ID

Parameters:
obj_id - - object ID of console object
Throws:
DuplicateObjectIDException - if ID is duplicate of existing object ID
Method Detail

UpdateUsingShadowRecord

public void UpdateUsingShadowRecord(byte[] buf,
                                    int rec_off,
                                    int rec_len)
Update object using shadow record created by the the engine object which is matched with this class.

Specified by:
UpdateUsingShadowRecord in class TWGConObject
Parameters:
buf - - byte array containing opaque representation of shadowed attributes
rec_off - - offset of shadow record in byte array
rec_len - - length of shadow record in byte array

toString

public java.lang.String toString()
Generate string representation of object

Overrides:
toString in class TWGConObject
Returns:
string representation

getName

public java.lang.String getName()
Get account name

Returns:
user account name

getFullName

public java.lang.String getFullName()
Get full user name

Returns:
full user name

getEMail

public java.lang.String getEMail()
Get user e-mail

Returns:
e-mail address

getPager

public java.lang.String getPager()
Get pager data

Returns:
pager data

getDescription

public java.lang.String getDescription()
Get description string

Returns:
description string

getPrivs

public StringValueSet getPrivs()
Get privilege token set for user

Returns:
read-only reference to user's privilege set

getTaskAccessList

public LongValueSet getTaskAccessList()
Get task access list

Returns:
read-only reference to user's allowed task IDs (if task restricted)

getGroupAccessList

public LongValueSet getGroupAccessList()
Get group access list

Returns:
read-only reference to user's allowed group IDs (if group restricted)

isGroupLimited

public boolean isGroupLimited()
Is user limited to a specific set of groups

Returns:
true if user if group limited

isTaskLimited

public boolean isTaskLimited()
Is user limited to a specific set of tasks

Returns:
true if user if task limited

isReadOnlyGroupAccess

public boolean isReadOnlyGroupAccess()
Is user limited to read-only access to groups

Returns:
true if user is limited to read-only group access

hasPrivilege

public boolean hasPrivilege(java.lang.String priv_id)
Test if user has given privilege

Parameters:
priv_id - - privilege ID to test for
Returns:
true if user has given privilege

getCurrent

public static TWGConUser getCurrent()
Get current user

Returns:
reference to active TWGConUser

currentHasPrivilege

public static boolean currentHasPrivilege(java.lang.String priv_id)
Test if current user has requested privilege

Parameters:
priv_id - - privilege ID to test for
Returns:
true if user has given privilege