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

Interface IGPRoleMap

public interface IGPRoleMap

Map roles from child elements to parent roles. Used for block roles mapping in IGPModifiableBlock.

Method Summary

Iterator	getRoleMappings() Get all role mappings.
Iterator	getRoleMappings(String parentRoleName) Get the role mappings for a given parent role.
IGPRoleMapping	mapRole(IGPRoleInfo childRole, String childId, IGPRoleInfo parentRole) Create role mapping and add it to this IGPRoleMap.
boolean	unmapRole(IGPRoleMapping mapping) Remove a given role mapping.

Method Detail

mapRole

public IGPRoleMapping mapRole(IGPRoleInfo childRole,
                              String childId,
                              IGPRoleInfo parentRole)
                       throws GPInvocationException

Create role mapping and add it to this IGPRoleMap.

Parameters:

childRole - the technical name of a role in a child IGPBlockStructureItem

childId - id of a child IGPBlockStructureItem

parentRole - technical name of a role in the parent IGPBlock

Returns:

the new added role mapping

Throws:

GPInvocationException

unmapRole

public boolean unmapRole(IGPRoleMapping mapping)
                  throws GPInvocationException

Remove a given role mapping.

Parameters:

mapping - the mapping to be removed

Returns:

true if the mapping was found; false otherwise.

Throws:

GPInvocationException

getRoleMappings

public Iterator getRoleMappings()

Get all role mappings.

Returns:

iterator of IGPRoleMapping elements

getRoleMappings

public Iterator getRoleMappings(String parentRoleName)

Get the role mappings for a given parent role.

Parameters:

parentRoleName - name of the parent role

Returns:

iterator of IGPRoleMapping elements