com.netscape.pm.model
Interface IParticipant

public interface IParticipant

Defines the Process Manager representation of a corporate directory user entity. Every user attribute that is available from the user entry can be accessed via this interface. For example, suppose we have an LDAP user entry for user id joe:

ICorporateDirectory cd = cluster.getCorporateDirectory(); IParticipant p = cd.getUserById( "joe" ); java.lang.System.out.println( "Joe's email is " + p.getPropertyValue( "mail" ) ); java.lang.System.out.println( "Joe's favorite color is " + p.getPropertyValue( "favoritecolor" ) );

In the case of LDAP user entries, multi-valued attributes are supported as a java.util.Vector of values being returned from getPropertyValue.

See Also:

ICorporateDirectory

Method Summary

java.util.Enumeration	getPropertyKeys() Returns a list of the attribute keys the participant contains.
java.lang.Object	getPropertyValue(java.lang.String key) Returns the value of a specific participant property.
java.lang.String	getUserId() Returns the user id (UID) of the participant.

Method Detail

getUserId

public java.lang.String getUserId()

Returns the user id (UID) of the participant. In the Process Manager world, this is assumed to be the primary key for a user in the corporate directory.

Returns:

the user id of the participant.

Since:

PM 6.0

getPropertyKeys

public java.util.Enumeration getPropertyKeys()

Returns a list of the attribute keys the participant contains.

Returns:

an enumeration of the attribute keys the participant contains.

Since:

PAE 4.0

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String key)
                                  throws PMException

Returns the value of a specific participant property. For LDAP corporate directories, single-valued user attributes will be returned as java.util.String; multi-valued user attributes will be returned as java.util.Vector of java.util.String.

Parameters:

key - the user attribute key

Returns:

the value associated with the user attribute key.

Throws:

PMException - if no such attribute exists.

Since:

PAE 4.0