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

Interface IGPDesigntimeUpdateManager

public interface IGPDesigntimeUpdateManager

The design time update manager provides the necessary functionality for creating, opening for edit, saving, activating and releasing GP objects. The supported objects are: callable objects, actions, blocks, processes and business objects. An instance of this class can be obtained using GPProcessFactory.getDesigntimeUpdateManager The method requires IUser and Locale, which are used in all operations invoked with this instance.

Method Summary

void	activate(IGPCallableObject callableObject) Activates this callable object version.
void	activate(IGPModifiableAction action) Activates this action version.
void	activate(IGPModifiableBlock block) Activates this block version.
void	activate(IGPModifiableBusinessObject businessObject) Activates this business object version.
void	activate(IGPModifiableProcess process) Activates this process version.
void	close() Closes the current manager session and frees the resources obtained during the session
IGPModifiableAction	createAction(Locale originalLocale, String title, String description, String categoryId) Creates an action with the specified original locale, title, descriptiom, and category identifier.
IGPModifiableBlock	createBlock(GPBlockType blockType, Locale originalLocale, String title, String description, String categoryId) Creates a block with the specified original locale, title, descriptiom, and category identifier.
IGPModifiableBusinessObject	createBusinessObject(Locale originalLocale, IGPBusinessObjectEndpoint endpoint, String nameProvider, String nameType, Date creationDate, String ownerUniqueId) Creates a business object with the specified locale, endpoint, name provider and type, creation date and owner id.
IGPCallableObject	createCallableObject(IGPCallableObjectType callableObjectType, Locale originalLocale, String title, String description, String categoryId) Creates a callable object with the specified type, title, description and category identifier.
IGPCategory	createCategory(String name, String description, IGPCategory parent) Creates a category with the specified name and desrciption and parent category.
IGPModifiableAction	createInactiveAction(String actionId) Creates a new inactive version of the action with the specified unique Id.
IGPModifiableBlock	createInactiveBlock(String blockId) Creates a new inactive version of the block with the specified unique Id.
IGPModifiableBusinessObject	createInactiveBusinessObject(String businessObjectId) Creates a new inactive version of the business Object with the specified unique Id.
IGPCallableObject	createInactiveCallableObject(String callableobjectId) Creates a new inactive version of the callable object with the specified unique Id.
IGPModifiableProcess	createInactiveProcess(String processId) Creates a new inactive version of the action with the specified unique Id.
IGPModifiableProcess	createProcess(Locale originalLocale, String title, String description, String categoryId) Creates a process with the specified original locale, title, descriptiom, and category identifier.
void	delete(IGPCallableObject callableObject) Deletes the callable object version form the database.
void	delete(IGPCategory category) Deletes a category from the category tree.
void	delete(IGPModifiableAction action) Deletes an action version from the database.
void	delete(IGPModifiableBlock block) Deletes a block verison form the database.
void	delete(IGPModifiableBusinessObject businessObject) Deletes a business object from the databse.
void	delete(IGPModifiableProcess process) Deletes a process version from the database.
Iterator	getActions(String[] categoryArray, GPDevelopmentObjectStatus[] statusArray) Searches for a list of actions in the specified category list, having the specified statuses
Iterator	getBlocks(String[] categoryArray, GPDevelopmentObjectStatus[] statusArray) Searches for a list of blocks in the specified category list, having the specified statuses
Iterator	getBusinessObjects(String[] categoryArray, GPDevelopmentObjectStatus[] statusArray) Searches for a list of business objects in the specified category list, having the specified statuses
Iterator	getCallableObjects(String[] categoryArray, GPDevelopmentObjectStatus[] statusArray) Searches for a list of callable objects in the specified category list, having the specified statuses
Iterator	getProcesses(String[] categoryArray, GPDevelopmentObjectStatus[] statusArray) Searches for a list of processes in the specified category list, having the specified statuses
IGPModifiableAction	openAction(String actionTemplateID, IGPVersionNumber version) Opens the action with the specified Id and version for edit.
IGPModifiableBlock	openBlock(String blockTemplateID, IGPVersionNumber version) Opens the block with the specified Id and version for edit.
IGPModifiableBusinessObject	openBusinessObject(String businessObjectID, IGPVersionNumber version) Opens the business object with the specified Id and version for edit.
IGPCallableObject	openCallableObject(String callableObjectID, IGPVersionNumber version) Opens the callable object with the specified Id and version for edit.
IGPModifiableProcess	openProcess(String processTemplateID, IGPVersionNumber version) Opens the process with the specified Id and version for edit.
void	release(IGPCallableObject callableObject) Releases the callable object so that can be edited in other sessions, thus removing any locks on the callable object
void	release(IGPModifiableAction action) Releases the action so that can be edited in other sessions, thus removing any locks on the action.
void	release(IGPModifiableBlock block) Releases the block so that can be edited in other sessions, thus removing any locks on the block.
void	release(IGPModifiableBusinessObject businessObject) Releases the business object so that can be edited in other sessions, thus removing any locks on the business object.
void	release(IGPModifiableProcess process) Releases the process so that can be edited in other sessions, thus removing any locks on the process.
void	save(IGPCallableObject callableObject) Saves the callable object to the database
void	save(IGPModifiableAction action) Saves the action to the database
void	save(IGPModifiableBlock block) Saves the block to the database
void	save(IGPModifiableBusinessObject businessObject) Saves the business object to the database
void	save(IGPModifiableProcess process) Saves the process to the database

Method Detail

createCallableObject

public IGPCallableObject createCallableObject(IGPCallableObjectType callableObjectType,
                                              Locale originalLocale,
                                              String title,
                                              String description,
                                              String categoryId)
                                       throws GPEngineException,
                                              GPInvocationException

Creates a callable object with the specified type, title, description and category identifier. The callable object is created with new UUID and version number 0.1.

Parameters:

callableObjectType - The type of the callable object. The type instance can obtained from the IGPCallableObjectTypeManager

originalLocale - the original locale for this callable object

title - the title of this callable object in the original locale

description - the description of the callable object in the original locale

categoryId - the Id of the category to which this callable object will be assigned. Category information could obtained from the IGPDesigntimeManager

Returns:

the newly created in memmory representation of the callable object

Throws:

GPEngineException - thrown if the Guided Procedures framework could not serve this request

GPInvocationException - thrown if incorrect parameteres are passed to the method

createAction

public IGPModifiableAction createAction(Locale originalLocale,
                                        String title,
                                        String description,
                                        String categoryId)
                                 throws GPEngineException,
                                        GPInvocationException

Creates an action with the specified original locale, title, descriptiom, and category identifier. The action is created with new UUID and version number 0.1.

Parameters:

originalLocale - the original locale of the action

title - the title of the action in the original locale

description - the description of the action in the original locale

categoryId - the Id of the category to which the action will be assigned

Returns:

the newly created in memory representation of the action

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createBlock

public IGPModifiableBlock createBlock(GPBlockType blockType,
                                      Locale originalLocale,
                                      String title,
                                      String description,
                                      String categoryId)
                               throws GPEngineException,
                                      GPInvocationException

Creates a block with the specified original locale, title, descriptiom, and category identifier. The block is created with new UUID and version number 0.1.

Parameters:

originalLocale - the original locale of the block

title - the title of the block in the original locale

description - the description of the block in the original locale

categoryId - the Id of the category to which the block will be assigned

Returns:

the newly created in memory representation of the block

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createProcess

public IGPModifiableProcess createProcess(Locale originalLocale,
                                          String title,
                                          String description,
                                          String categoryId)
                                   throws GPEngineException,
                                          GPInvocationException

Creates a process with the specified original locale, title, descriptiom, and category identifier. The process is created with new UUID and version number 0.1.

Parameters:

originalLocale - the original locale of the process

title - the title of the process in the original locale

description - the description of the process in the original locale

categoryId - the Id of the category to which the process will be assigned

Returns:

the newly created in memory representation of the process

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createBusinessObject

public IGPModifiableBusinessObject createBusinessObject(Locale originalLocale,
                                                        IGPBusinessObjectEndpoint endpoint,
                                                        String nameProvider,
                                                        String nameType,
                                                        Date creationDate,
                                                        String ownerUniqueId)
                                                 throws GPEngineException,
                                                        GPInvocationException

Creates a business object with the specified locale, endpoint, name provider and type, creation date and owner id.

Parameters:

originalLocale - the original locale

endpoint - the endpoint to the target system

nameProvider - the name providere

nameType - the name type

creationDate - the creation date

ownerUniqueId - the owner unique Id

Returns:

the newly created business object

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createInactiveCallableObject

public IGPCallableObject createInactiveCallableObject(String callableobjectId)
                                               throws GPEngineException,
                                                      GPInvocationException

Creates a new inactive version of the callable object with the specified unique Id. The local part of the version number is counted up. The new inactive version is not automatically persisted

Parameters:

callableobjectId - the id of the callable object.

Returns:

the new callable object version

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createInactiveAction

public IGPModifiableAction createInactiveAction(String actionId)
                                         throws GPEngineException,
                                                GPInvocationException

Creates a new inactive version of the action with the specified unique Id. The local part of the version number is counted up. The new inactive version is not automatically persisted

Parameters:

actionId - the id of the action.

Returns:

the new action version

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createInactiveBlock

public IGPModifiableBlock createInactiveBlock(String blockId)
                                       throws GPEngineException,
                                              GPInvocationException

Creates a new inactive version of the block with the specified unique Id. The local part of the version number is counted up. The new inactive version is not automatically persisted

Parameters:

blockId - the id of the block.

Returns:

the new block version

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createInactiveProcess

public IGPModifiableProcess createInactiveProcess(String processId)
                                           throws GPEngineException,
                                                  GPInvocationException

Creates a new inactive version of the action with the specified unique Id. The local part of the version number is counted up. The new inactive version is not automatically persisted

Returns:

the new callable object version

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createInactiveBusinessObject

public IGPModifiableBusinessObject createInactiveBusinessObject(String businessObjectId)
                                                         throws GPEngineException,
                                                                GPInvocationException

Creates a new inactive version of the business Object with the specified unique Id. The local part of the version number is counted up. The new inactive version is not automatically persisted

Parameters:

businessObjectId - the id of the business Object.

Returns:

the new business Object version

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

openCallableObject

public IGPCallableObject openCallableObject(String callableObjectID,
                                            IGPVersionNumber version)
                                     throws GPEngineException,
                                            GPInvocationException

Opens the callable object with the specified Id and version for edit. The callable object version is locked for editing in this session. For unlocking the callable object use the corresponding release() method.

Parameters:

callableObjectID - the id of the callable object to be opened in edit mode

version - the version of the callable object

Returns:

the callable object to be edited

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

openAction

public IGPModifiableAction openAction(String actionTemplateID,
                                      IGPVersionNumber version)
                               throws GPEngineException,
                                      GPInvocationException

Opens the action with the specified Id and version for edit. The action version is locked for editing in this session. For unlocking the action use the corresponding release() method.

Parameters:

actionTemplateID - the id of the action to be opened in edit mode

version - the version of the action

Returns:

the action to be edited

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

openBlock

public IGPModifiableBlock openBlock(String blockTemplateID,
                                    IGPVersionNumber version)
                             throws GPEngineException,
                                    GPInvocationException

Opens the block with the specified Id and version for edit. The block version is locked for editing in this session. For unlocking the block use the corresponding release() method.

Parameters:

blockTemplateID - the id of the block to be opened in edit mode

version - the version of the block

Returns:

the block to be edited

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

openProcess

public IGPModifiableProcess openProcess(String processTemplateID,
                                        IGPVersionNumber version)
                                 throws GPEngineException,
                                        GPInvocationException

Opens the process with the specified Id and version for edit. The process version is locked for editing in this session. For unlocking the process use the corresponding release() method.

Parameters:

processTemplateID - the id of the process to be opened in edit mode

version - the version of the process

Returns:

the process to be edited

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

openBusinessObject

public IGPModifiableBusinessObject openBusinessObject(String businessObjectID,
                                                      IGPVersionNumber version)
                                               throws GPEngineException,
                                                      GPInvocationException

Opens the business object with the specified Id and version for edit. The business object version is locked for editing in this session. For unlocking the business object use the corresponding release() method.

Parameters:

businessObjectID - the id of the business object to be opnend in edit mode

version - the version of the business object

Returns:

the business object to be edited

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

save

public void save(IGPCallableObject callableObject)
          throws GPEngineException,
                 GPInvocationException

Saves the callable object to the database

Parameters:

callableObject - the callable object to be saved

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

save

public void save(IGPModifiableAction action)
          throws GPEngineException,
                 GPInvocationException

Saves the action to the database

Parameters:

action - the action to be saved

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

save

public void save(IGPModifiableBlock block)
          throws GPEngineException,
                 GPInvocationException

Saves the block to the database

Parameters:

block - the block to be saved

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

save

public void save(IGPModifiableProcess process)
          throws GPEngineException,
                 GPInvocationException

Saves the process to the database

Parameters:

process - the process to be saved

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

save

public void save(IGPModifiableBusinessObject businessObject)
          throws GPEngineException,
                 GPInvocationException

Saves the business object to the database

Parameters:

businessObject - the business object to be saved

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

delete

public void delete(IGPCallableObject callableObject)
            throws GPEngineException,
                   GPInvocationException

Deletes the callable object version form the database. The callable object is only deleted if it is not used by other objects

Parameters:

callableObject - the object to be deleted

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

delete

public void delete(IGPModifiableAction action)
            throws GPEngineException,
                   GPInvocationException

Deletes an action version from the database. The action is only deleted if it is not used by other objects

Parameters:

action - the action to be deleted.

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

delete

public void delete(IGPModifiableBlock block)
            throws GPEngineException,
                   GPInvocationException

Deletes a block verison form the database. The block is only deleted if it is not used by other objects

Parameters:

block - the block to be deleted

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

delete

public void delete(IGPModifiableProcess process)
            throws GPEngineException,
                   GPInvocationException

Deletes a process version from the database. The process is deleted if it is not used by other objects

Parameters:

process - the process to be deleted

Throws:

GPEngineException - thrown if incorrect parameters are passed to this method

GPInvocationException - thrown if incorrect parameters are passed to this method

delete

public void delete(IGPModifiableBusinessObject businessObject)
            throws GPEngineException,
                   GPInvocationException

Deletes a business object from the databse. The business object is deleted if it is not used by other objects

Parameters:

businessObject - the business object to be deleted

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

activate

public void activate(IGPCallableObject callableObject)
              throws GPEngineException,
                     GPInvocationException

Activates this callable object version. After activation the calalble object version could not edited any more. Only versions that have been activated could be used when starting a process.

Parameters:

callableObject - the callable object to be activated

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

activate

public void activate(IGPModifiableAction action)
              throws GPEngineException,
                     GPInvocationException

Activates this action version. After the activation the action version could not be edited any more. Only versions that have been activated could be used when starting a process.

Parameters:

action - the action to be activated

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

activate

public void activate(IGPModifiableBlock block)
              throws GPEngineException,
                     GPInvocationException

Activates this block version. After the activation the block version could not be edited any more. Only versions that have been activated could be used when starting a process.

Parameters:

block - the block to be activated

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

activate

public void activate(IGPModifiableProcess process)
              throws GPEngineException,
                     GPInvocationException

Activates this process version. After the activation the process version could not be edited any more. Only activated process version could be initiated.

Parameters:

process - the process to be activated

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

activate

public void activate(IGPModifiableBusinessObject businessObject)
              throws GPEngineException,
                     GPInvocationException

Activates this business object version. After the activation the business object version could not be edited any more

Parameters:

businessObject - the business object to be activated

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

getCallableObjects

public Iterator getCallableObjects(String[] categoryArray,
                                   GPDevelopmentObjectStatus[] statusArray)
                            throws GPEngineException,
                                   GPInvocationException

Searches for a list of callable objects in the specified category list, having the specified statuses

Parameters:

categoryArray - array if the category identifiers to be searched for callable objects. This parameter could be left null meaning that the method will search in any directory

statusArray - the status of the callable object to be searched for. This parameter could be left null, meaning that the method will search for callable objects with any status.

Returns:

read only iterator with instance of IGPDevelopmentObjectInfo describing the callable objects

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

getActions

public Iterator getActions(String[] categoryArray,
                           GPDevelopmentObjectStatus[] statusArray)
                    throws GPEngineException,
                           GPInvocationException

Searches for a list of actions in the specified category list, having the specified statuses

Parameters:

categoryArray - array if the category identifiers to be searched for actions. This parameter could be left null meaning that the method will search in any directory

statusArray - the status of the actions to be searched for. This parameter could be left null, meaning that the method will search for actions with any status.

Returns:

read only iterator with instance of IGPDevelopmentObjectInfo describing the actions

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

getBlocks

public Iterator getBlocks(String[] categoryArray,
                          GPDevelopmentObjectStatus[] statusArray)
                   throws GPEngineException,
                          GPInvocationException

Searches for a list of blocks in the specified category list, having the specified statuses

Parameters:

categoryArray - array if the category identifiers to be searched for blocks. This parameter could be left null meaning that the method will search in any directory

statusArray - the status of the blocks to be searched for. This parameter could be left null, meaning that the method will search for blocks with any status.

Returns:

read only iterator with instance of IGPDevelopmentObjectInfo describing the blocks

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

getProcesses

public Iterator getProcesses(String[] categoryArray,
                             GPDevelopmentObjectStatus[] statusArray)
                      throws GPEngineException,
                             GPInvocationException

Searches for a list of processes in the specified category list, having the specified statuses

Parameters:

categoryArray - array if the category identifiers to be searched for processes. This parameter could be left null meaning that the method will search in any directory

statusArray - the status of the processes to be searched for. This parameter could be left null, meaning that the method will search for processes with any status.

Returns:

read only iterator with instance of IGPDevelopmentObjectInfo describing the processes

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

getBusinessObjects

public Iterator getBusinessObjects(String[] categoryArray,
                                   GPDevelopmentObjectStatus[] statusArray)
                            throws GPEngineException,
                                   GPInvocationException

Searches for a list of business objects in the specified category list, having the specified statuses

Parameters:

categoryArray - array if the category identifiers to be searched for business objects. This parameter could be left null meaning that the method will search in any directory

statusArray - the status of the business objects to be searched for. This parameter could be left null, meaning that the method will search for business objects with any status.

Returns:

read only iterator with instance of IGPDevelopmentObjectInfo describing the business objects

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

release

public void release(IGPCallableObject callableObject)
             throws GPEngineException,
                    GPInvocationException

Releases the callable object so that can be edited in other sessions, thus removing any locks on the callable object

Parameters:

callableObject - the callable object to be released

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

release

public void release(IGPModifiableAction action)
             throws GPEngineException,
                    GPInvocationException

Releases the action so that can be edited in other sessions, thus removing any locks on the action.

Parameters:

action - the action to be released

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

release

public void release(IGPModifiableBlock block)
             throws GPEngineException,
                    GPInvocationException

Releases the block so that can be edited in other sessions, thus removing any locks on the block.

Parameters:

block - the block to be released

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

release

public void release(IGPModifiableProcess process)
             throws GPEngineException,
                    GPInvocationException

Releases the process so that can be edited in other sessions, thus removing any locks on the process.

Parameters:

process - the process to be released

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

release

public void release(IGPModifiableBusinessObject businessObject)
             throws GPEngineException,
                    GPInvocationException

Releases the business object so that can be edited in other sessions, thus removing any locks on the business object.

Parameters:

businessObject - the business object to be released

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

createCategory

public IGPCategory createCategory(String name,
                                  String description,
                                  IGPCategory parent)
                           throws GPEngineException,
                                  GPInvocationException

Creates a category with the specified name and desrciption and parent category.

Parameters:

name - the name of the category in the default locale for the session.

description - the description of the categoryu in the default locale for the session.

parent - the parent category of the new category

Returns:

the newly created category

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

delete

public void delete(IGPCategory category)
            throws GPEngineException,
                   GPInvocationException

Deletes a category from the category tree. The category subtree is also deleted.

Parameters:

category - the category to be deleted

Throws:

GPEngineException - thrown if the guided procedures framework could not serve the request

GPInvocationException - thrown if incorrect parameters are passed to this method

close

public void close()

Closes the current manager session and frees the resources obtained during the session