com.brightech.mb.workflow.js

Class User

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.User

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class User
extends JSBaseScriptableObject

Javascript object representing a user's information not including any session-specific information.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
Group[]	(JavaScript Function) getGroups() Get an array of groups this user is a member of.
Group	(JavaScript Function) getPrimaryGroup() Gets the user's primary group.
java.lang.String	(JavaScript Function) getStatus() Get the user's current status.
java.lang.String	(JavaScript Function) getType() Returns the user type for the current user.
ACL[]	(JavaScript Function) getUserACLs() Get user-type ACLs available to this user.
boolean	(JavaScript Function) isGlobalAdmin() Is the user a global administrator
void	(JavaScript Function) setPassword(java.lang.String thePassword) Set the user's password.
void	(JavaScript Function) setStatus(java.lang.String theStatus) Set the user's status.
void	(JavaScript Function) setType(java.lang.String theType) Set the user's type.
void	(JavaScript Function) updateContactInfo() Updates the user's ContactInfo in the user database.
java.lang.String	(JavaScript Getter) address1()
java.lang.String	(JavaScript Getter) address2()
java.lang.String	(JavaScript Getter) city()
java.lang.String	(JavaScript Getter) company()
java.lang.String	(JavaScript Getter) country()
int	(JavaScript Getter) currentACLGroupId() Returns the current ACL group ID.
java.lang.String	(JavaScript Getter) dept()
java.lang.String	(JavaScript Getter) email()
java.lang.String	(JavaScript Getter) ext()
java.lang.String	(JavaScript Getter) firstName() ContactInfo getters/setters
java.lang.String	(JavaScript Getter) fullName() This method returns user's full name
int	(JavaScript Getter) groupId() Returns the primary group ID.
java.lang.String	(JavaScript Getter) lastName()
java.lang.String	(JavaScript Getter) login() Returns the user login.
java.lang.String	(JavaScript Getter) middleName()
java.lang.String	(JavaScript Getter) phone()
java.lang.String	(JavaScript Getter) position()
java.lang.String	(JavaScript Getter) state()
int	(JavaScript Getter) userId() Returns the user ID.
java.lang.String	(JavaScript Getter) username() Returns the username.
java.lang.String	(JavaScript Getter) zip()
void	(JavaScript Setter) address1(java.lang.String theAddress1)
void	(JavaScript Setter) address2(java.lang.String theAddress2)
void	(JavaScript Setter) city(java.lang.String theCity)
void	(JavaScript Setter) company(java.lang.String theCompany)
void	(JavaScript Setter) country(java.lang.String theCountry)
void	(JavaScript Setter) dept(java.lang.String theDept)
void	(JavaScript Setter) email(java.lang.String theEmail)
void	(JavaScript Setter) ext(java.lang.String theExt)
void	(JavaScript Setter) firstName(java.lang.String theFirstName)
void	(JavaScript Setter) lastName(java.lang.String theLastName)
void	(JavaScript Setter) middleName(java.lang.String theMiddleName)
void	(JavaScript Setter) phone(java.lang.String thePhone)
void	(JavaScript Setter) position(java.lang.String thePosition)
void	(JavaScript Setter) state(java.lang.String theState)
void	(JavaScript Setter) zip(java.lang.String theZip)

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

User

public User()

Method Detail

(JavaScript Getter) userId

public int (JavaScript Getter) userId()

Returns the user ID.

Returns:

the user ID.

(JavaScript Getter) fullName

public java.lang.String (JavaScript Getter) fullName()

This method returns user's full name

Returns:

full name

(JavaScript Getter) login

public java.lang.String (JavaScript Getter) login()

Returns the user login. (Legacy method: See username.)

Returns:

the user login.

(JavaScript Getter) username

public java.lang.String (JavaScript Getter) username()

Returns the username.

Returns:

the username.

(JavaScript Getter) groupId

public int (JavaScript Getter) groupId()

Returns the primary group ID.

Returns:

the primary group ID.

See Also:

User.getPrimaryGroup()

(JavaScript Getter) currentACLGroupId

public int (JavaScript Getter) currentACLGroupId()

Returns the current ACL group ID.

Returns:

the id

(JavaScript Getter) firstName

public java.lang.String (JavaScript Getter) firstName()

ContactInfo getters/setters

(JavaScript Setter) firstName

public void (JavaScript Setter) firstName(java.lang.String theFirstName)

(JavaScript Getter) middleName

public java.lang.String (JavaScript Getter) middleName()

(JavaScript Setter) middleName

public void (JavaScript Setter) middleName(java.lang.String theMiddleName)

(JavaScript Getter) lastName

public java.lang.String (JavaScript Getter) lastName()

(JavaScript Setter) lastName

public void (JavaScript Setter) lastName(java.lang.String theLastName)

(JavaScript Getter) address1

public java.lang.String (JavaScript Getter) address1()

(JavaScript Setter) address1

public void (JavaScript Setter) address1(java.lang.String theAddress1)

(JavaScript Getter) address2

public java.lang.String (JavaScript Getter) address2()

(JavaScript Setter) address2

public void (JavaScript Setter) address2(java.lang.String theAddress2)

(JavaScript Getter) city

public java.lang.String (JavaScript Getter) city()

(JavaScript Setter) city

public void (JavaScript Setter) city(java.lang.String theCity)

(JavaScript Getter) state

public java.lang.String (JavaScript Getter) state()

(JavaScript Setter) state

public void (JavaScript Setter) state(java.lang.String theState)

(JavaScript Getter) zip

public java.lang.String (JavaScript Getter) zip()

(JavaScript Setter) zip

public void (JavaScript Setter) zip(java.lang.String theZip)

(JavaScript Getter) country

public java.lang.String (JavaScript Getter) country()

(JavaScript Setter) country

public void (JavaScript Setter) country(java.lang.String theCountry)

(JavaScript Getter) company

public java.lang.String (JavaScript Getter) company()

(JavaScript Setter) company

public void (JavaScript Setter) company(java.lang.String theCompany)

(JavaScript Getter) position

public java.lang.String (JavaScript Getter) position()

(JavaScript Setter) position

public void (JavaScript Setter) position(java.lang.String thePosition)

(JavaScript Getter) email

public java.lang.String (JavaScript Getter) email()

(JavaScript Setter) email

public void (JavaScript Setter) email(java.lang.String theEmail)

(JavaScript Getter) dept

public java.lang.String (JavaScript Getter) dept()

(JavaScript Setter) dept

public void (JavaScript Setter) dept(java.lang.String theDept)

(JavaScript Getter) phone

public java.lang.String (JavaScript Getter) phone()

(JavaScript Setter) phone

public void (JavaScript Setter) phone(java.lang.String thePhone)

(JavaScript Getter) ext

public java.lang.String (JavaScript Getter) ext()

(JavaScript Setter) ext

public void (JavaScript Setter) ext(java.lang.String theExt)

(JavaScript Function) updateContactInfo

public void (JavaScript Function) updateContactInfo()

Updates the user's ContactInfo in the user database.

(JavaScript Function) getGroups

public Group[] (JavaScript Function) getGroups()

Get an array of groups this user is a member of.

Returns:

An array of groups this user is a member of.

(JavaScript Function) getPrimaryGroup

public Group (JavaScript Function) getPrimaryGroup()

Gets the user's primary group.

Returns:

primary group

(JavaScript Function) getUserACLs

public ACL[] (JavaScript Function) getUserACLs()

Get user-type ACLs available to this user.

Returns:

The user-type ACLs available to this user.

(JavaScript Function) getStatus

public java.lang.String (JavaScript Function) getStatus()

Get the user's current status.

Returns:

the user's current status.

(JavaScript Function) setStatus

public void (JavaScript Function) setStatus(java.lang.String theStatus)

Set the user's status.

Parameters:

theStatus - the user's new status.

(JavaScript Function) setType

public void (JavaScript Function) setType(java.lang.String theType)

Set the user's type. Valid options include: Global Administrator, Group Administrator and General User.

Parameters:

theType - the user's new type.

(JavaScript Function) getType

public java.lang.String (JavaScript Function) getType()

Returns the user type for the current user.

Returns:

the user type, one of: Global Administrator, Group Administrator and General User

(JavaScript Function) isGlobalAdmin

public boolean (JavaScript Function) isGlobalAdmin()

Is the user a global administrator

Returns:

true if so, false otherwise

(JavaScript Function) setPassword

public void (JavaScript Function) setPassword(java.lang.String thePassword)

Set the user's password.

Parameters:

thePassword - The user's new password.