|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWUserInfo
Use this class to access information for a specific user.
Create an instance of this class using any among the VWSession.fetchUserInfo(), VWSystemAdministration.createUserInfo(), and VWSystemAdministration.fetchUserInfo() methods.
VWSystemAdministration.createUserInfo()
,
VWSystemAdministration.fetchUserInfo(String)
, Serialized FormField Summary | |
static int |
NOTIFICATION_MILESTONE_ORIGINATOR
Value of 512: signifies the notification flag is "Originator Milestone". |
static int |
NOTIFICATION_MILESTONE_TRACKER
Value of 256: signifies the notification flag is "Tracker Milestone". |
static int |
NOTIFICATION_STEP_EXPIRED_DEADLINE
Value of 2: signifies the notification flag is "Step Expired Deadline". |
static int |
NOTIFICATION_STEP_NEW_ASSIGNMENT
Value of 1: signifies the notification flag is "Step New Assignment". |
static int |
NOTIFICATION_STEP_REMINDERS
Value of 4: signifies the notification flag is "Step Reminders". |
static int |
NOTIFICATION_TRACKER_EXPIRED_DEADLINE
Value of 16: signifies the notification flag is "Tracker Expired Deadline". |
static int |
NOTIFICATION_TRACKER_NEW_ASSIGNMENT
Value of 32: signifies the notification flag is "Tracker New Assignment". |
static int |
NOTIFICATION_TRACKER_REMINDERS
Value of 64: signifies the notification flag is "Tracker Reminders". |
static int |
NOTIFICATION_TRACKER_STEP_EXPIRED_DEADLINE
Value of 128: signifies the notification flag is "Tracker Step Expired Deadline". |
static int |
NOTIFICATION_TRACKER_WORKFLOW_EXCEPTION
Value of 8: signifies the notification flag is "Tracker Workflow Exception". |
static int |
NOTIFICATION_UNDEFINED
Value of 0: signifies the notification flag is "Undefined". |
static int |
SERVER_ID_UNSPECIFIED
Value of -1: signifies the Server ID is unspecified. |
Method Summary | |
void |
deleteField(java.lang.String fieldName)
Deletes the named field entry. |
java.lang.String |
getEMailAddress()
Gets the email address of the current user. |
int |
getFieldType(java.lang.String fieldName)
Returns the field type of the input field name. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Gets the object value for the input field name. |
static java.lang.String |
getLocalizedString(int theNotificationType)
Gets a localized representation of the notification type. |
java.lang.String |
getName()
Gets the name of the current user. |
int |
getNotificationFlags()
Gets the number that represents the combined notification flag settings for the user. |
java.lang.String |
getProxyUserName()
Gets the proxy user name. |
int |
getServerAssignment()
Gets the server ID associated with the user. |
boolean |
isFieldArray(java.lang.String fieldName)
Determines whether a field is an array. |
static boolean |
isValid(int theNotificationType)
Determines whether the specified notification type is valid. |
void |
save()
Saves the values set for the current user. |
void |
setEMailAddress(java.lang.String theEMailAddress)
Sets the email address of the current user. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Creates, deletes, or updates a UserInfo field. |
void |
setName(java.lang.String theUserName)
Sets the name of the current user. |
void |
setNotificationFlags(int theFlags)
Sets the notification flag settings for the current user. |
void |
setProxyUserName(java.lang.String theUserName)
Sets the proxy user name for this user information object. A proxy user receives work on behalf of the current user. |
void |
setServerAssignment(int theServerId)
Assigns a server ID for the current user. |
java.lang.String |
toString()
Gets the string version of the user name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int NOTIFICATION_UNDEFINED
public static final int NOTIFICATION_STEP_NEW_ASSIGNMENT
public static final int NOTIFICATION_STEP_EXPIRED_DEADLINE
public static final int NOTIFICATION_STEP_REMINDERS
public static final int NOTIFICATION_TRACKER_WORKFLOW_EXCEPTION
public static final int NOTIFICATION_TRACKER_EXPIRED_DEADLINE
public static final int NOTIFICATION_TRACKER_NEW_ASSIGNMENT
public static final int NOTIFICATION_TRACKER_REMINDERS
public static final int NOTIFICATION_TRACKER_STEP_EXPIRED_DEADLINE
public static final int NOTIFICATION_MILESTONE_TRACKER
public static final int NOTIFICATION_MILESTONE_ORIGINATOR
public static final int SERVER_ID_UNSPECIFIED
Method Detail |
public java.lang.String getEMailAddress()
public void setEMailAddress(java.lang.String theEMailAddress) throws VWException
theEmailAddress
- The new email
address of the current user.VWException
- Throws an exception if there is an error
while setting the email address.public java.lang.String getName()
public void setName(java.lang.String theUserName) throws VWException
theUserName
- The name of the current user.VWException
- Thrown if it cannot
set the name of the current user. An example would be when
the input name is null or empty.public java.lang.String getProxyUserName() throws VWException
VWException
- Thrown if the proxy user ID
cannot be converted to a user name. This may occur if the user
ID is not found on server.public void setProxyUserName(java.lang.String theUserName) throws VWException
theUserName
- The proxy user name.VWException
- Thrown if the method cannot
set the proxy name for this user information object. An example
would be if the input name is invalid.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
fieldName
- The name of the field whose value is set. Null
is not permitted.fieldValue
- The object value that represents the named
field. The type for this value must be one of the basic field types,
and if the field specified by the fieldName parameter exists, the
type of the fieldValue object must match the type of the named
field. Passing null for the fieldValue parameter in conjunction
with passing an existing field name for the fieldName parameter
deletes the existing field.VWException
- Causes include the following conditions:
getFieldType(String)
,
VWFieldType
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the field.VWException
- Causes include passing a null value for
the fieldName parameter.getFieldType(String)
public int getFieldType(java.lang.String fieldName) throws VWException
fieldName
- The name of the field
whose type will be returned.VWException
- Thrown if the
fieldName parameter is null.public boolean isFieldArray(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to check.true
if the field is an array;
false
if the field is not an array.VWException
- Thrown if the
fieldName parameter is null.public void deleteField(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to be deleted.VWException
- Thrown if it cannot
delete a field entry. An example would be when a field name does
not exist.public int getNotificationFlags()
public void setNotificationFlags(int theFlags) throws VWException
theFlags
- An integer that holds the bitwise OR operation value of the
notification flags.
VWException
- Thrown if there
is an error while setting the notification flags, for example,
if the theFlags parameter is less than or greater than the possible
respective minimum or maximum values, give the above flag values.public int getServerAssignment()
public void setServerAssignment(int theServerId) throws VWException
theServerId
- An integer value specifying the server ID for the
server you want to assign to the user.VWException
- Thrown if it cannot
assign a server ID for the current user. The ID for the server
must exist on the system and the server
ID must be valid (greater than or equal to 0).public void save() throws VWException
VWException
- Thrown if it cannot
save the values set for the current user. An example would be
if the user name is null, empty, or otherwise invalid.public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String getLocalizedString(int theNotificationType) throws VWException
theNotificationType
- An integer value specifying the
notification type value to be represented by a string. Valid
input values are listed below:
VWException
- The method throws an exception if the
notification type specified in the theNotificationType
parameter is invalid.public static boolean isValid(int theNotificationType)
theNotificationType
- An integer value specifying the
notification type value to be validated. Valid input values
are listed below:
true
if
the notification type specified in the theNotificationType
parameter is valid; false
if the notification type
is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |