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

Interface IGPModifiableBlock

All Superinterfaces:

IGPActivity, IGPBlock, IGPDevelopmentObject, IGPModifiableActivity, IGPModifiableDevelopmentObject

All Known Subinterfaces:

IGPModifiableProcess

public interface IGPModifiableBlock
extends IGPModifiableActivity, IGPBlock

Represents a block i.e. container for activities. The block type is specified by its creation using GPBlockType constants. Children of the block are defined in a IGPModifiableBlockStructure. Roles of processors can be added or removed and mapped from children to the parent using IGPRoleMap.

Version:

1.0

Method Summary

IGPModifiableRoleInfo	addRole(String techName, String text) Add a new role with given name and display text.
GPBlockType	getBlockType() Get the block type associated with this block by creation.
IGPModifiableBlockStructure	getModifiableStructure() Access the structure of this block in order to add, remove or access its children.
IGPModifiableRoleInfo	getRole(String techName) Get the role with a given role name.
IGPRoleMap	getRoleMap() Get the role map used to modify mappings from child roles to this block roles.
Iterator	getRoles() Get all the roles defined for this block.
boolean	removeRole(String techName) Delete a role with a given technical name.
void	setHiddenInRuntimeViews(boolean hiddenInRuntime) Sets whether the block should be hidden in the runtime views or not.

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

Method Detail

getBlockType

GPBlockType getBlockType()

Get the block type associated with this block by creation.

Returns:

the GPBlockType constant of the block.

getModifiableStructure

IGPModifiableBlockStructure getModifiableStructure()

Access the structure of this block in order to add, remove or access its children.

Returns:

the modifiable structure of the block

getRoles

Iterator getRoles()

Get all the roles defined for this block.

Returns:

the iterator of IGPModifiableRoleInfo objects

getRole

IGPModifiableRoleInfo getRole(String techName)

Get the role with a given role name.

Parameters:

techName - the name of the role

Returns:

the role associated with the given name or null if no such

addRole

IGPModifiableRoleInfo addRole(String techName,
                              String text)
                              throws GPInvocationException

Add a new role with given name and display text. 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

Returns:

the newly created and added to this block role

Throws:

GPInvocationException - if the techName is unacceptable

removeRole

boolean removeRole(String techName)
                   throws GPInvocationException

Delete a role with a given technical name. All the mappings pointing to the role will also be removed.

Parameters:

techName - role name

Returns:

true if there was such role; false otherwise

Throws:

GPInvocationException

getRoleMap

IGPRoleMap getRoleMap()

Get the role map used to modify mappings from child roles to this block roles.

Returns:

the RoleMap of this block

setHiddenInRuntimeViews

void setHiddenInRuntimeViews(boolean hiddenInRuntime)

Sets whether the block should be hidden in the runtime views or not.

Parameters:

hiddenInRuntime -