|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWParticipant
public class VWParticipant
Use this class to represent the name of a user or user group in any of the following ways:
Field Summary | |
---|---|
static int |
PARTICIPANT_TYPE_GROUP
Value of 2; indicates the participant type is group. |
static int |
PARTICIPANT_TYPE_UNDEFINED
Value of 0; indicates the participant type is undefined. |
static int |
PARTICIPANT_TYPE_USER
Value of 1; indicates the participant type is user. |
Constructor Summary | |
---|---|
VWParticipant()
Constructs a participant object. |
|
VWParticipant(java.lang.String theParticipantName)
Constructs a participant object and sets the participant name property. |
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. |
java.lang.Object |
clone()
Creates a clone of this VWParticipant object. |
java.lang.String |
getDisplayName()
Gets the participant display name. |
java.lang.String |
getDistinguishedName()
Gets the distinguished name (DN) of the participant user or group. |
java.lang.String |
getDomainName()
Gets the name of the domain associated with the VWParticipant object. |
java.lang.String |
getGUID()
Gets the GUID of the participant. |
java.lang.String |
getParticipantName()
Returns the "short" or "logon" name of a participant user or group. |
long |
getUserId()
Gets the user id associated with the VWParticipant object. |
boolean |
isGroup()
Indicates if the current instance of VWParticipant is a group. |
boolean |
isVerified()
Return true if this object was initialized using data from the server |
void |
setParticipantName(java.lang.String theParticipantName)
Sets the "short" or "logon" name of a participant user or group. |
java.lang.String |
toString()
Returns the "short" or "logon" name of a participant user or group. |
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 PARTICIPANT_TYPE_UNDEFINED
public static final int PARTICIPANT_TYPE_USER
public static final int PARTICIPANT_TYPE_GROUP
Constructor Detail |
---|
public VWParticipant()
public VWParticipant(java.lang.String theParticipantName)
theParticipantName
- "Short" or "logon" name
of a participant user or group.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 boolean isVerified()
public java.lang.Object clone()
VWParticipant
object.
clone
in class java.lang.Object
public java.lang.String getParticipantName()
setParticipantName(String)
public void setParticipantName(java.lang.String theParticipantName)
theParticipantName
- The "short" or "login" name of the
participant user or grouppublic java.lang.String toString()
toString
in class java.lang.Object
getParticipantName()
public java.lang.String getDistinguishedName()
public java.lang.String getDisplayName()
public java.lang.String getGUID()
public long getUserId()
public java.lang.String getDomainName()
public boolean isGroup()
true
if the participant is a grouppublic 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
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |