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

Interface IGPModifiableProcess

All Superinterfaces:

IGPActivity, IGPBlock, IGPDevelopmentObject, IGPModifiableActivity, IGPModifiableBlock, IGPModifiableDevelopmentObject, IGPProcess

public interface IGPModifiableProcess
extends IGPModifiableBlock, IGPProcess

Represents a process definition.

Version:

1.0

Method Summary

void	addRestrictionPrincipal(IPrincipal principal) Adds a principal to the restriction list
IGPModifiableRoleInfo	addRole(String techName, String text, GPRoleType type) Add a new role with given name, display text and role type.
String	getDefaultRuntimeView() Returns the id of the default runtime view
IGPModifiableRoleInfo	getModifiableAdminRole() Returns the Admin Role for this process
IGPModifiableRoleInfo	getModifiableOverseerRole() Return the Overseer Role for this process
IGPModifiableRoleInfo	getModifiableOwnerRole() Return the Owner Role for this process
GPProcessMultiplicity	getProcessMultiplicity() Get the process multiplicity.
Iterator	getRestrictionPrincipals() Retrieves all principals from the restriction list
Iterator	getRuntimeViews() Returns the list of all views that will be shown at runtime
boolean	isAutomaticallyStarted() Returns true if the process should be automatically started By default, the process is not automatically started
boolean	isRestrictDefaultRolePrincipals() Denotes whether the principals that are assigned to the default roles should be restricted to the set of principals assigned in design time
void	removeAllRestrictionPrincipals() Removes all principals from the restriction list
IPrincipal	removeRestrictionPrincipal(String uniqueId) Removes a principal with a given ID from the restriction list
void	setAutomaticallyStartedMode(boolean isAutomaticallyStarted) Sets whether the process should be automatically started or not.
void	setDefaultRuntimeView(String viewID) Sets the default runtime view
void	setProcessMultiplicity(GPProcessMultiplicity multiplicity) Set the process multiplicity.
void	setRuntimeViews(List views) Sets the list of all views that will be shown at runtime

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

addRole, getBlockType, getModifiableStructure, getRole, getRoleMap, getRoles, removeRole, setHiddenInRuntimeViews

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

addAdHocActivity, addAttachment, addAttachmentId, addInfoCallableObject, isPersisted, removeAdHocActivity, removeAttachment, removeInfoCallableObject, setAttachmentIdList, setInputMappingGroup, setLocalParameters, setOutputMappingGroup

Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPModifiableDevelopmentObject

addPermission, addToCategory, removeFromCategory, removePermission, removePermission, setDescription, setInputParameters, setOutputParameters, setTitle, validate

Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPDevelopmentObject

getCategories, getDescription, getMetadata, getOriginalLocale, getPermissions, getStatus, getTitle, getType

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

getAdhocActivities, getAssignedCategories, getAttachmentIds, getAttachments, getCreationDate, getCreator, getID, getInfoCallableObjects, getInputMappingGroup, getInputParameters, getLocalParameters, getOutputMappingGroup, getOutputParameters, getParentBlock, getParentProcess, getVersionNumber, isAction, isBlock, resolveDescription, resolveTitle

Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPDevelopmentObject

getCategories, getDescription, getMetadata, getOriginalLocale, getPermissions, getStatus, getTitle, getType

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

getRoleInfo, getRoleInfoCount, getStructure, getValidUntilDate, hasAdministratorPermission, hasInstantiatePermission, hasWritePermission, isHiddenInRuntimeViews

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

getAdhocActivities, getAssignedCategories, getAttachmentIds, getAttachments, getCreationDate, getCreator, getID, getInfoCallableObjects, getInputMappingGroup, getInputParameters, getLocalParameters, getOutputMappingGroup, getOutputParameters, getParentBlock, getParentProcess, getVersionNumber, isAction, isBlock, resolveDescription, resolveTitle

Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPDevelopmentObject

getCategories, getDescription, getMetadata, getOriginalLocale, getPermissions, getStatus, getTitle, getType

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

getAdminRole, getOverseerRole, getOwnerRole

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

getRoleInfo, getRoleInfoCount, getStructure, getValidUntilDate, hasAdministratorPermission, hasInstantiatePermission, hasWritePermission, isHiddenInRuntimeViews

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

getAdhocActivities, getAssignedCategories, getAttachmentIds, getAttachments, getCreationDate, getCreator, getID, getInfoCallableObjects, getInputMappingGroup, getInputParameters, getLocalParameters, getOutputMappingGroup, getOutputParameters, getParentBlock, getParentProcess, getVersionNumber, isAction, isBlock, resolveDescription, resolveTitle

Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPDevelopmentObject

getCategories, getDescription, getMetadata, getOriginalLocale, getPermissions, getStatus, getTitle, getType

Method Detail

getProcessMultiplicity

GPProcessMultiplicity getProcessMultiplicity()

Get the process multiplicity.

Returns:

one of GPProcessMultiplicity constants.

setProcessMultiplicity

void setProcessMultiplicity(GPProcessMultiplicity multiplicity)

Set the process multiplicity.

Parameters:

multiplicity - one of GPProcessMultiplicity constants.

getRuntimeViews

Iterator getRuntimeViews()

Returns the list of all views that will be shown at runtime

setRuntimeViews

void setRuntimeViews(List views)

Sets the list of all views that will be shown at runtime

setDefaultRuntimeView

void setDefaultRuntimeView(String viewID)

Sets the default runtime view

getDefaultRuntimeView

String getDefaultRuntimeView()

Returns the id of the default runtime view

getModifiableAdminRole

IGPModifiableRoleInfo getModifiableAdminRole()

Returns the Admin Role for this process

Returns:

getModifiableOverseerRole

IGPModifiableRoleInfo getModifiableOverseerRole()

Return the Overseer Role for this process

Returns:

getModifiableOwnerRole

IGPModifiableRoleInfo getModifiableOwnerRole()

Return the Owner Role for this process

Returns:

addRole

IGPModifiableRoleInfo addRole(String techName,
                              String text,
                              GPRoleType type)
                              throws GPInvocationException

Add a new role with given name, display text and role type. The technical name of the role should not contain whitespace and should be no longer than 32 chararcters. The name is unique across all roles that have already been defined for the block.

Parameters:

techName - role name

text - role text

type - the role type see GPRoleType constants

Returns:

the newly created and added to this block role

Throws:

GPInvocationException - if the techName or the type is unacceptable

isRestrictDefaultRolePrincipals

boolean isRestrictDefaultRolePrincipals()

Denotes whether the principals that are assigned to the default roles should be restricted to the set of principals assigned in design time

Returns:

a boolean value

addRestrictionPrincipal

void addRestrictionPrincipal(IPrincipal principal)

Adds a principal to the restriction list

Parameters:

principal - - the principal to be added

removeRestrictionPrincipal

IPrincipal removeRestrictionPrincipal(String uniqueId)

Removes a principal with a given ID from the restriction list

Parameters:

uniqueId - - the unique ID of the principal to be removed

Returns:

the principal that was removed or null if not found

removeAllRestrictionPrincipals

void removeAllRestrictionPrincipals()

Removes all principals from the restriction list

getRestrictionPrincipals

Iterator getRestrictionPrincipals()

Retrieves all principals from the restriction list

Returns:

principles vector

isAutomaticallyStarted

boolean isAutomaticallyStarted()

Returns true if the process should be automatically started By default, the process is not automatically started

Specified by:

isAutomaticallyStarted in interface IGPProcess

Returns:

boolean

setAutomaticallyStartedMode

void setAutomaticallyStartedMode(boolean isAutomaticallyStarted)

Sets whether the process should be automatically started or not.

Parameters:

isAutomaticallYStarted -