|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWUserInfo
public final class VWUserInfo
Use this class to access information for a specific user.
Create instances of this class using any of the following methods:
VWSession.fetchUserInfo
VWSession.fetchUserInfoList
VWSession.fetchUserRecords
VWSystemAdministration.createUserInfo
VWSystemAdministration.fetchUserInfo
VWSystemAdministration.createUserInfo(java.lang.String)
,
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 | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
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 basic field type of the specified field name. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Returns an Object representing the specified field name. |
static java.lang.String |
getLocalizedString(int theNotificationType)
Gets a localized representation of the notification type. |
java.lang.String |
getName()
Returns the name of the current user. |
VWParticipant |
getNamePx()
Returns the VWParticipant security object for the current user. |
int |
getNotificationFlags()
Gets the number that represents all the notification type settings (indicated by NOTIFICATION_*) for this instance. |
java.util.Locale |
getPreferredLocale()
Gets the preferred locale to be used for email notification. |
java.lang.String |
getProxyUserName()
Gets the proxy user name as a String. |
VWParticipant |
getProxyUserNamePx()
Gets the proxy user name as an instance of a VWParticipant object. |
int |
getServerAssignment()
Deprecated. BPM 4.0 release farming does not support multiple servers |
boolean |
isFieldArray(java.lang.String fieldName)
Indicates whether a field is an array. |
static boolean |
isValid(int theNotificationType)
Indicates whether the specified notification type is valid. |
void |
save()
Saves the values set for this instance. |
void |
setEMailAddress(java.lang.String theEMailAddress)
Sets the email address for the current user. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Creates, deletes, or updates a field for this instance. |
void |
setName(java.lang.String theUserName)
Deprecated. VWUserInfo records are created on the server, the name cannot be changed |
void |
setNotificationFlags(int theFlags)
Sets the notification flag settings for this instance. |
void |
setPreferredLocale(java.util.Locale myLocale)
Sets the preferred locale to be used for client email notification. |
void |
setProxyUserName(java.lang.String theUserName)
Sets the proxy user name for this instance, within the default domain. |
void |
setProxyUserNameByDomain(java.lang.String theDomainName,
java.lang.String theUserName)
Sets the proxy user name for this user information object. |
void |
setServerAssignment(int theServerId)
Deprecated. BPM 4.0 release farming does not support multiple servers |
java.lang.String |
toString()
Returns the String version of the user name for this instance. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
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 static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getEMailAddress()
public void setEMailAddress(java.lang.String theEMailAddress) throws VWException
theEmailAddress
- The new email address of the current user.
VWException
public java.lang.String getName()
public VWParticipant getNamePx() throws VWException
VWException
public void setName(java.lang.String theUserName) throws VWException
theUserName
- The name to be set for the current user.
VWException
- Thrown for various causes, including when
the input name is null, empty, or otherwise invalid.public java.lang.String getProxyUserName() throws VWException
VWException
- Thrown for various causes, including when
the user ID is not found on server.public VWParticipant getProxyUserNamePx() throws VWException
VWException
- Thrown for various causes, including when
the proxy user ID cannot be converted to a user name (such as when the
user ID is not found on the server).public void setProxyUserName(java.lang.String theUserName) throws VWException
theUserName
- The proxy user name. This can be null when there is no proxy user.
VWException
- Thrown for various causes, including when
the input name is invalid.public void setProxyUserNameByDomain(java.lang.String theDomainName, java.lang.String theUserName) throws VWException
theDomainName
- The specified domain to search for
the specified name.theUserName
- The proxy user name. This can be null when there is
no proxy user.
VWException
- Thrown for various causes, including when
the input name is not unique or is not found withint the specified
domain.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
fieldName
- The name of the field whose value is set. This cannot be null.fieldValue
- An Object that represents the specified field, or null.
The type for this object must be one of the basic field types.
If the field specified in fieldName exists, the type of the fieldValue object must match the type of the named
field. Null deletes the field specified in fieldName.
VWException
- Causes include the following conditions:
getFieldType(java.lang.String)
,
VWFieldType
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to return.
VWException
- Thrown for various causes, including when
the fieldName parameter is null.getFieldType(java.lang.String)
public int getFieldType(java.lang.String fieldName) throws VWException
fieldName
- The name of the field whose basic field type
will be returned.
VWException
- Thrown for various causes, including when
the fieldName parameter is null.public boolean isFieldArray(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to check.
VWException
- Thrown for various causes, including when
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 for various reason, including when
a field name does not exist.public int getNotificationFlags()
public void setNotificationFlags(int theFlags) throws VWException
theFlags
- An integer indicating a bitwise OR of the desired
notification types (indicated by NOTIFICATION_*).
VWException
- Thrown for various causes, including when
the theFlags parameter is outside the range of the bitwise OR value of the notification flags.public int getServerAssignment()
public void setServerAssignment(int theServerId) throws VWException
theServerId
- An integer representing the server ID for the server to be assigned
to this instance.
VWException
- Thrown for various causes, including when
the specified server ID is invalid (less than 0}.public void save() throws VWException
VWException
- Thrown for various reasons, including when
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 representing the
notification type (indicated by NOTIFICATION_*) to be localized.
VWException
- The method throws an exception if the
notification type specified is invalid.public static boolean isValid(int theNotificationType)
theNotificationType
- An integer representing the
notification type (indicated by NOTIFICATION_*) to be validated.
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void setPreferredLocale(java.util.Locale myLocale) throws VWException
myLocale
- A Locale object specifying the preferred locale for the client. This can be null, indicating
in this case, that the default Process Engine server language is to be used for email notification.
VWException
VWSession.fetchAvailableLocales()
,
VWSession.fetchServerLocale()
public java.util.Locale getPreferredLocale() throws VWException
VWException
VWSession.fetchAvailableLocales()
,
VWSession.fetchServerLocale()
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |