com.prosyst.mprm.admin.procedures

Interface ProcedureInventory

All Superinterfaces:

Folder

public interface ProcedureInventory
extends Folder

The Procedure Inventory service.

Field Summary

Fields inherited from interface com.prosyst.mprm.admin.procedures.Folder

PROCEDURE_ARGUMENTS, PROCEDURE_HAS_SHORTCUT, PROCEDURE_ICON_REF, PROCEDURE_NAME, PROCEDURE_PATH, PROCEDURE_TEXT

Method Summary

Modifier and Type	Method and Description
void	addProcedureListener(ProcedureListener listener) Registers a procedure listener.
Folder	getFolderByPath(java.lang.String path) Returns the folder with a given full path.
Procedure	getProcedureByPath(java.lang.String path) Returns the procedure with a given full path.
Procedure[]	getShortcutProcedures() Gets all the procedures from the inventory which have a shortcut.
void	removeProcedureListener(ProcedureListener listener) Unregisters a procedure listener.

Methods inherited from interface com.prosyst.mprm.admin.procedures.Folder

addProcedure, addProcedure, addProcedure, createFolder, createProcedureArgument, deleteFolder, deleteProcedure, exportInventory, exportProcedures, getFolder, getFolders, getFullPath, getName, getPath, getProcedure, getProcedureNames, getProcedures, getProcedureText, importInventory, isEmpty, moveTo, parseProcedureText

Method Detail

getFolderByPath

Folder getFolderByPath(java.lang.String path)
                throws ManagementException

Returns the folder with a given full path. If there is no such folder null will be returned. If the path argument is null or empty String returns this object.

Parameters:

path - the path to the folder in format <folder1>/<folder2>/.../<folderN>

Returns:

a Folder object represented the folder with the given path

Throws:

ManagementException - if system error occurs or the logged user does not imply the proper role.

getProcedureByPath

Procedure getProcedureByPath(java.lang.String path)
                      throws ManagementException

Returns the procedure with a given full path. If there is no such procedure null will be retuned.

Parameters:

path - the path to the procedure in format <folder1>/<folder2>/.../<folderN>/<ProcName>

Returns:

a Procedure object represented the procedure with the given path

Throws:

ManagementException - if system error occurs or the logged user does not imply the proper role.

getShortcutProcedures

Procedure[] getShortcutProcedures()
                           throws ManagementException

Gets all the procedures from the inventory which have a shortcut. The method will be used to show all shortcut procedures and use them with minimum efforts.

Returns:

all procedures with assigned shortcut; or an empty array if there are not any.

Throws:

ManagementException - if system error occurs or the logged user does not imply the proper role.

addProcedureListener

void addProcedureListener(ProcedureListener listener)
                   throws ManagementException

Registers a procedure listener.

Parameters:

listener - application defined listener.

Throws:

ManagementException - if system error occurs.

removeProcedureListener

void removeProcedureListener(ProcedureListener listener)

Unregisters a procedure listener.

Parameters:

listener - application defined listener.