Process API

filenet.vw.api
Class VWParticipant

java.lang.Object
  extended by filenet.vw.api.VWParticipant
All Implemented Interfaces:
IVWtoXML, java.io.Serializable, java.lang.Cloneable

public class VWParticipant
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, IVWtoXML

Use this class to represent the name of a user or user group in any of the following ways:

Since:
VWWS3.10
See Also:
Serialized Form

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

PARTICIPANT_TYPE_UNDEFINED

public static final int PARTICIPANT_TYPE_UNDEFINED
Value of 0; indicates the participant type is undefined.

See Also:
Constant Field Values

PARTICIPANT_TYPE_USER

public static final int PARTICIPANT_TYPE_USER
Value of 1; indicates the participant type is user.

See Also:
Constant Field Values

PARTICIPANT_TYPE_GROUP

public static final int PARTICIPANT_TYPE_GROUP
Value of 2; indicates the participant type is group.

See Also:
Constant Field Values
Constructor Detail

VWParticipant

public VWParticipant()
Constructs a participant object.


VWParticipant

public VWParticipant(java.lang.String theParticipantName)
Constructs a participant object and sets the participant name property.

Parameters:
theParticipantName - "Short" or "logon" name of a participant user or group.
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.

Returns:
the file author

_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.

Returns:
the file revision

isVerified

public boolean isVerified()
Return true if this object was initialized using data from the server

Returns:
true if this object was initialized using data from the server

clone

public java.lang.Object clone()
Creates a clone of this VWParticipant object.

Overrides:
clone in class java.lang.Object
Returns:
a clone of this instance.

getParticipantName

public java.lang.String getParticipantName()
Returns the "short" or "logon" name of a participant user or group.

Returns:
The "short" or "login" name of the participant user or group
See Also:
setParticipantName(String)

setParticipantName

public void setParticipantName(java.lang.String theParticipantName)
Sets the "short" or "logon" name of a participant user or group.

Parameters:
theParticipantName - The "short" or "login" name of the participant user or group

toString

public java.lang.String toString()
Returns the "short" or "logon" name of a participant user or group.

Overrides:
toString in class java.lang.Object
Returns:
The "short" or "login" name of the participant user or group
See Also:
getParticipantName()

getDistinguishedName

public java.lang.String getDistinguishedName()
Gets the distinguished name (DN) of the participant user or group.

Returns:
The distinguished name of the participant user or group

getDisplayName

public java.lang.String getDisplayName()
Gets the participant display name.

Returns:
The display name of the participant user or group

getGUID

public java.lang.String getGUID()
Gets the GUID of the participant.

Returns:
The GUID of the participant

getUserId

public long getUserId()
Gets the user id associated with the VWParticipant object.

Returns:
The user id of the participant associated with the VWParticipant object.

getDomainName

public java.lang.String getDomainName()
Gets the name of the domain associated with the VWParticipant object.

Returns:
The domain name

isGroup

public boolean isGroup()
Indicates if the current instance of VWParticipant is a group.

Returns:
true if the participant is a group

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.