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

Interface IGPModifiableRoleInfo

All Superinterfaces:

IGPRoleInfo

public interface IGPModifiableRoleInfo
extends IGPRoleInfo

Represents a role. Roles are used to define processors for various activities. An IGPAction has a single default role. An IGPBlock has a collection of roles. If not modified, the block roles should be the union of all the roles of its children. The name of the role serves as its identifier. It is specified at creation time and cannot be modified. The action role will be created by adding the action to a block structure. Its name will be the action technical name. The action role is accessible trough IGPModifiableAction.getActionRole() The block roles can be created or deleted through the IGPModifiableBlock interface. By adding a new child to the block, its roles should be copied automatically to the parent. Further a mapping could be defined from child roles to parent roles in order to consolidate the processors of the block. This is done trough the IGPRoleMap interface.

Version:

0.1

Field Summary

static String	ROLE_ADMIN_TEXT
static String	ROLE_OVERSEER_TEXT
static String	ROLE_OWNER_TEXT
static String	ROLE_TYPE_ADMIN
static String	ROLE_TYPE_OVERSEER
static String	ROLE_TYPE_OWNER

Fields inherited from interface com.sap.caf.eu.gp.process.api.IGPRoleInfo

ROLE_TYPE_INITIATION_DEFINED, ROLE_TYPE_INITIATOR, ROLE_TYPE_RT_DEFINED

Method Summary

void	addDefault(IPrincipal principal) A default user for the role
void	deleteDefault(String principalId) Remove the default user of the role.
void	deleteDefaults() Remove all defaults defined for the role
IPrincipal	getDefaultPrincipal(String principalId) Returns the IPrincipal corresponding the given Id, if it exists.
Iterator	getDefaults() Returns an Enumeration of IPrincipal that are assigned for this role
IGPMappingRule	getFilledFromContextParam() Gets the context parameter from which this role should be filled
boolean	isDefaultDefinitionRequired() Returns if a set of defaults has to be defined.
boolean	isExceptionHandlerDedicated()
boolean	isFilledFromContextParam() Shows the type of this role
void	setDefaults(Iterator principals) Sets a set of IPrincipal as new Defaults for the role
boolean	setIsDefaultDefinitionRequired(boolean setDefault) Sets whether defaults have to be defined for this role or not.
void	setIsOverWriteAllowed(boolean isOverWrite) Sets whether the defined defaults can be overwritten or not.
void	setRoleID(String id) Set the Id for the role
void	setRoleType(GPRoleType roleType) Sets the role type.
void	setText(String txt)

Methods inherited from interface com.sap.caf.eu.gp.process.api.IGPRoleInfo

getRoleID, getRoleName, getText, getType, isOverWriteAllowed

Field Detail

ROLE_TYPE_ADMIN

static final String ROLE_TYPE_ADMIN

See Also:

Constant Field Values

ROLE_TYPE_OVERSEER

static final String ROLE_TYPE_OVERSEER

See Also:

Constant Field Values

ROLE_TYPE_OWNER

static final String ROLE_TYPE_OWNER

See Also:

Constant Field Values

ROLE_ADMIN_TEXT

static final String ROLE_ADMIN_TEXT

See Also:

Constant Field Values

ROLE_OVERSEER_TEXT

static final String ROLE_OVERSEER_TEXT

See Also:

Constant Field Values

ROLE_OWNER_TEXT

static final String ROLE_OWNER_TEXT

See Also:

Constant Field Values

Method Detail

setRoleID

void setRoleID(String id)

Set the Id for the role

setIsOverWriteAllowed

void setIsOverWriteAllowed(boolean isOverWrite)

Sets whether the defined defaults can be overwritten or not.

Parameters:

isOverWrite -

getDefaults

Iterator getDefaults()

Returns an Enumeration of IPrincipal that are assigned for this role

deleteDefaults

void deleteDefaults()
                    throws GPInvocationException

Remove all defaults defined for the role

Throws:

InvocationException

GPInvocationException

addDefault

void addDefault(IPrincipal principal)
                throws GPInvocationException

A default user for the role

Throws:

GPInvocationException

setDefaults

void setDefaults(Iterator principals)

Sets a set of IPrincipal as new Defaults for the role

getDefaultPrincipal

IPrincipal getDefaultPrincipal(String principalId)

Returns the IPrincipal corresponding the given Id, if it exists.

deleteDefault

void deleteDefault(String principalId)

Remove the default user of the role.

isDefaultDefinitionRequired

boolean isDefaultDefinitionRequired()

Returns if a set of defaults has to be defined.

setIsDefaultDefinitionRequired

boolean setIsDefaultDefinitionRequired(boolean setDefault)

Sets whether defaults have to be defined for this role or not.

setRoleType

void setRoleType(GPRoleType roleType)

Sets the role type.

isExceptionHandlerDedicated

boolean isExceptionHandlerDedicated()

Returns:

true if the role is related to an exception handler

getFilledFromContextParam

IGPMappingRule getFilledFromContextParam()

Gets the context parameter from which this role should be filled

Returns:

the parameter (null if it is a normal role)

isFilledFromContextParam

boolean isFilledFromContextParam()

Shows the type of this role

Specified by:

isFilledFromContextParam in interface IGPRoleInfo

Returns:

true - the role is filled from a context parameter flase - this is a normal role

setText

void setText(String txt)
             throws GPInvocationException,
                    GPEngineException

Throws:

GPInvocationException

GPEngineException