com.sap.caf.eu.gp.base.api

Interface IGPModifiableDevelopmentObject

All Superinterfaces:

IGPDevelopmentObject

All Known Subinterfaces:

IGPCallableObject, IGPModifiableAction, IGPModifiableActivity, IGPModifiableBlock, IGPModifiableBusinessObject, IGPModifiableFormDevObject, IGPModifiableProcess

public interface IGPModifiableDevelopmentObject
extends IGPDevelopmentObject

The modifiable development object provides write access to the properties of a development object. This class allows change in input and output parameters as well as in the permission and category assignment.

Version:

1.0

Method Summary

void	addPermission(IPrincipal principal, GPPermissionType permissionType) Adds a permission to the Development Object.
void	addToCategory(String categoryId) Assigns the development object to a category
void	removeFromCategory(String categoryId) Removes category assignment of the development object.
IGPPermission	removePermission(IGPPermission permission) Removes a permission from the Development Object.
IGPPermission	removePermission(IPrincipal principal, GPPermissionType permissionType) Removes a permission from the Development Object.
void	setDescription(String description) Sets the description in original locale of the development object.
void	setInputParameters(IGPStructureInfo structureInfo) Sets the input parameter type definition in the development object.
void	setOutputParameters(IGPStructureInfo structureInfo) Sets the output parameter type definition in the development object.
void	setTitle(String title) Sets the title in the orginal locale of the development object.
void	validate() Validates the current status of the development object.

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

getCategories, getDescription, getID, getInputParameters, getMetadata, getOriginalLocale, getOutputParameters, getPermissions, getStatus, getTitle, getType, getVersionNumber, resolveDescription, resolveTitle

Method Detail

setTitle

void setTitle(String title)
              throws GPInvocationException

Sets the title in the orginal locale of the development object.

Parameters:

title - the title in the original locale of the development object

Throws:

GPInvocationException - thrown if the specified title is null

setDescription

void setDescription(String description)
                    throws GPInvocationException

Sets the description in original locale of the development object.

Parameters:

description - the description in the original locale

Throws:

GPInvocationException - thrown if the description is null

setInputParameters

void setInputParameters(IGPStructureInfo structureInfo)
                        throws GPInvocationException,
                               GPEngineException

Sets the input parameter type definition in the development object. The method should be called after a change in the input parameter definition is done.

Parameters:

structureInfo, - must not be null

Throws:

GPInvocationException - thrown if the specified structure is null

GPEngineException - thrown if the input parameters cannot be correctly updated in the development object

setOutputParameters

void setOutputParameters(IGPStructureInfo structureInfo)
                         throws GPInvocationException,
                                GPEngineException

Sets the output parameter type definition in the development object. The method should be called after a change in the output parameter definition is done.

Parameters:

structureInfo, - must not be null

Throws:

GPInvocationException - thrown if the specified structure is null

GPEngineException - thrown if the output parameters cannot be correctly updated in the development object

addPermission

void addPermission(IPrincipal principal,
                   GPPermissionType permissionType)
                   throws GPInvocationException

Adds a permission to the Development Object.

Parameters:

principal - principal who gets the permission

permissionType - the pemission type to be granted

Throws:

InvocationException - thrown is invalid principal or permission type are passed

GPInvocationException

removePermission

IGPPermission removePermission(IGPPermission permission)
                               throws GPInvocationException

Removes a permission from the Development Object.

Parameters:

permission, - must not be null

Returns:

the permission that has been removed, null if the table did not contain the specified element

Throws:

GPInvocationException

removePermission

IGPPermission removePermission(IPrincipal principal,
                               GPPermissionType permissionType)
                               throws GPInvocationException

Removes a permission from the Development Object.

Parameters:

principal - principal who got the permission

permissionType - the permission type to be removed

Returns:

Throws:

InvocationException

GPInvocationException

addToCategory

void addToCategory(String categoryId)
                   throws GPInvocationException

Assigns the development object to a category

Parameters:

categoryId - the id of the category

Throws:

GPInvocationException - thrown if the id is not correct

removeFromCategory

void removeFromCategory(String categoryId)
                        throws GPInvocationException

Removes category assignment of the development object.

Parameters:

categoryId - the id of the category

Throws:

GPInvocationException - thrown if the id is not correct

validate

void validate()
              throws GPEngineException

Validates the current status of the development object.

Throws:

GPEngineException - throwns if the development object definition is invalid.