com.sap.caf.eu.gp.process.api

Interface IGPProcessRoleInstance

public interface IGPProcessRoleInstance

The process role instance represents the role wehich is responsible for the current callable object execution. The process role instance is obtained from the execution cotnext of the callable object.

Method Summary

void	addRuntimeDefinedUser(IUser user) Adds a runtime defined user to this process role instance
void	addUser(IUser user) Adds a user the given process role.
Enumeration	getAddedUsers() Returns the users added during the last operation
String	getProcessRoleTechName() Returns the technical name of the process role.
Collection	getUserAsCollection() Returns the the users currently assigned to this process role instance as a collection
Enumeration	getUsers() Returns the users currently assigned to this process role isntance as an enumeration
boolean	isMember(IUser user) Check whether a given user is member of a role.
boolean	moveAddedUsersToClassicUsers() Move the recent added users to the classic users.
void	removeRuntimeDefinedUser(IUser user) Deprecated. !!!This method doesn't work for the bussiness workflow engine!!! Removes the given Runtime defined user from the process role instance.
void	removeUser(IUser user) Removes a user from the list.
void	setUsers(List users) Replaces all existing users by the given list of users.

Method Detail

getProcessRoleTechName

public String getProcessRoleTechName()

Returns the technical name of the process role.

Returns:

the technical name of the process role

getUsers

public Enumeration getUsers()

Returns the users currently assigned to this process role isntance as an enumeration

Returns:

Returns an Enumeration of IUser.

getUserAsCollection

public Collection getUserAsCollection()

Returns the the users currently assigned to this process role instance as a collection

Returns:

Returns an Collection of IUser.

addUser

public void addUser(IUser user)

Adds a user the given process role.

Parameters:

user - the user to be added to the process role isntance

removeUser

public void removeUser(IUser user)

Removes a user from the list.

Parameters:

user - the user to be removed from the current process role instance

setUsers

public void setUsers(List users)

Replaces all existing users by the given list of users.

Parameters:

users - the new list of users to be responsible for this process role isntance

getAddedUsers

public Enumeration getAddedUsers()

Returns the users added during the last operation

Returns:

the added users to the process role isntance

moveAddedUsersToClassicUsers

public boolean moveAddedUsersToClassicUsers()

Move the recent added users to the classic users. I.e. the new users will be now consider like Design Time defined users.

Returns:

true if there is at least a user that has be moved, whether false.

addRuntimeDefinedUser

public void addRuntimeDefinedUser(IUser user)

Adds a runtime defined user to this process role instance

Parameters:

user - the user to be added at runtime to this process role instance

removeRuntimeDefinedUser

public void removeRuntimeDefinedUser(IUser user)

Deprecated. !!!This method doesn't work for the bussiness workflow engine!!! Removes the given Runtime defined user from the process role instance.

Parameters:

user - the user to be removed form the runtime defined users

isMember

public boolean isMember(IUser user)

Check whether a given user is member of a role.

Parameters:

user - the user to be chekced for participating in this process role isntance

Returns:

whether the process role instance contains this user