com.prosyst.mprm.admin.procedures

Interface Folder

All Known Subinterfaces:

ProcedureInventory

public interface Folder

Procedures can be arranged in folders. Each folder can contain procedures as well as other folders. Each folder has unique name in the scope of its parent folder. ProcedureInventory is a folder too and it is the common parent of all other folders and procedures.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROCEDURE_ARGUMENTS A constant used for export and import functionality of the folder.
static java.lang.String	PROCEDURE_HAS_SHORTCUT A constant used for export and import functionality of the folder.
static java.lang.String	PROCEDURE_ICON_REF A constant used for export and import functionality of the folder.
static java.lang.String	PROCEDURE_NAME A constant used for export and import functionality of the folder.
static java.lang.String	PROCEDURE_PATH A constant used for export and import functionality of the folder.
static java.lang.String	PROCEDURE_TEXT A constant used for export and import functionality of the folder.

Method Summary

Modifier and Type	Method and Description
void	addProcedure(java.lang.String name, java.io.InputStream in) Adds procedure with a given name and script text supplied as an input stream to the current folder.
void	addProcedure(java.lang.String name, java.lang.String text) Adds procedure with a given name and script text to the current folder.
Procedure	addProcedure(java.lang.String name, java.lang.String text, boolean hasShortcut, Argument[] arguments, java.io.InputStream icon) Adds a procedure with a given name and all the other parameters.
Folder	createFolder(java.lang.String name) Creates a new subfolder of this folder.
Argument	createProcedureArgument(java.lang.String description, java.lang.String type, java.lang.String[] values) Creates a new instance of Argument type.
void	deleteFolder() Deletes the current folder and all its content.
void	deleteProcedure(java.lang.String name) Deletes procedure with a given name.
void	exportInventory(java.io.OutputStream out) Exports the content of the folder into a Java Archive file.
void	exportProcedures(Folder[] folders, Procedure[] procedures, java.io.OutputStream out) Exports the content of the given folders and procedures as a ZIP archive file.
Folder	getFolder(java.lang.String name) Returns sub folder with a given name.
Folder[]	getFolders() Returns all sub folders of this folder.
java.lang.String	getFullPath() Returns the full path to this folder in format <folder1>/<folder2>/.../<folderName>.
java.lang.String	getName() Gets the name of the folder.
java.lang.String	getPath() Returns the full path to this folder in format <folder1>/<folder2>/.../<folderN>.
Procedure	getProcedure(java.lang.String name) Gets a procedure object, containing its name, text and its metadata from the inventory.
java.lang.String[]	getProcedureNames() Returns the names of all procedures contained in this folder.
Procedure[]	getProcedures() Gets all procedures objects in this folder from the inventory.
java.lang.String	getProcedureText(java.lang.String name) Returns the script text of a procedure with a given name.
void	importInventory(java.io.InputStream in) Imports the saved procedures from a file in this folder.
boolean	isEmpty() Returns whether the folder is empty, i.e.
void	moveTo(java.lang.String targetFolderPath, boolean replace) Move this folder to the specified one.
int	parseProcedureText(java.lang.String text) Parses the given procedure text to extract all procedure parameters.

Field Detail

PROCEDURE_NAME

static final java.lang.String PROCEDURE_NAME

A constant used for export and import functionality of the folder.

See Also:

Constant Field Values

PROCEDURE_PATH

static final java.lang.String PROCEDURE_PATH

A constant used for export and import functionality of the folder.

See Also:

Constant Field Values

PROCEDURE_ICON_REF

static final java.lang.String PROCEDURE_ICON_REF

A constant used for export and import functionality of the folder.

See Also:

Constant Field Values

PROCEDURE_ARGUMENTS

static final java.lang.String PROCEDURE_ARGUMENTS

A constant used for export and import functionality of the folder.

See Also:

Constant Field Values

PROCEDURE_TEXT

static final java.lang.String PROCEDURE_TEXT

A constant used for export and import functionality of the folder.

See Also:

Constant Field Values

PROCEDURE_HAS_SHORTCUT

static final java.lang.String PROCEDURE_HAS_SHORTCUT

A constant used for export and import functionality of the folder.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws ManagementException

Gets the name of the folder. It must not contain the symbol /. This symbol is the separator of the folders.

Returns:

the folder name.

Throws:

ManagementException - if system error occurs.

getPath

java.lang.String getPath()
                  throws ManagementException

Returns the full path to this folder in format <folder1>/<folder2>/.../<folderN>. It does not contain its name.

Returns:

the folder path.

Throws:

ManagementException - if system error occurs.

getFullPath

java.lang.String getFullPath()
                      throws ManagementException

Returns the full path to this folder in format <folder1>/<folder2>/.../<folderName>. It contains the folder name. This method shall be used when there is a need for concatenation of the folder path and the folder name. The separator char between the path and the name is /.

Returns:

the folder path.

Throws:

ManagementException - if system error occurs.

isEmpty

boolean isEmpty()
         throws ManagementException

Returns whether the folder is empty, i.e. it does not contain other folder or procedures.

Returns:

true if the folder is empty.

Throws:

ManagementException - if system error occurs.

createFolder

Folder createFolder(java.lang.String name)
             throws ManagementException

Creates a new subfolder of this folder. If the folder is successfully added an event shall be generated with type ProcedureEvent.FOLDER_ADDED and it contains the added folder as source available via getSource().

Parameters:

name - the name of the folder. It must be unique in the scope of this folder.

Returns:

the new created folder

Throws:

ManagementException - if the name of the folder already exists or system level error occurs or the logged user does not imply the proper role.

getFolders

Folder[] getFolders()
             throws ManagementException

Returns all sub folders of this folder.

Returns:

array of sub folders.

Throws:

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

getFolder

Folder getFolder(java.lang.String name)
          throws ManagementException

Returns sub folder with a given name. If the folder with this name does not exist, the method returns null.

Parameters:

name - the name of folder.

Returns:

the wanted sub folder object.

Throws:

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

addProcedure

void addProcedure(java.lang.String name,
                  java.lang.String text)
           throws ManagementException

Adds procedure with a given name and script text to the current folder. If there is already procedure with this name it is overwritten.

Parameters:

name - name of the procedure.

text - the script text of the procedure.

Throws:

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

addProcedure

Procedure addProcedure(java.lang.String name,
                       java.lang.String text,
                       boolean hasShortcut,
                       Argument[] arguments,
                       java.io.InputStream icon)
                throws ManagementException

Adds a procedure with a given name and all the other parameters. If there is already procedure with this name it is overwritten.

Parameters:

name - name of the procedure.

text - script text of the procedure.

hasShortcut - if there is assigned a shortcut to it

arguments - the arguments info of the procedure

icon - the icon data

Returns:

a Procedure object represented the added procedure

Throws:

ManagementException - if system error occurs or if the length of arguments is different from result of the method parseProcedureText() or the logged user does not imply the proper role.

addProcedure

void addProcedure(java.lang.String name,
                  java.io.InputStream in)
           throws ManagementException

Adds procedure with a given name and script text supplied as an input stream to the current folder. If there is already procedure with this name it is overwritten.

Parameters:

name - name of the procedure.

in - input stream contains the text of the procedure.

Throws:

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

getProcedureText

java.lang.String getProcedureText(java.lang.String name)
                           throws ManagementException

Returns the script text of a procedure with a given name. If there is no such procedure null is returned.

Parameters:

name - name of the procedure.

Returns:

procedure text as String.

Throws:

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

getProcedureNames

java.lang.String[] getProcedureNames()
                              throws ManagementException

Returns the names of all procedures contained in this folder.

Returns:

array of procedure names of this folder

Throws:

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

deleteProcedure

void deleteProcedure(java.lang.String name)
              throws ManagementException

Deletes procedure with a given name. If there is no such procedure this method does nothing.

Parameters:

name - name of the procedure.

Throws:

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

deleteFolder

void deleteFolder()
           throws ManagementException

Deletes the current folder and all its content. An event with type ProcedureEvent.FOLDER_REMOVED shall be generated and shall contain the full path of the removed folder.

Throws:

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

getProcedures

Procedure[] getProcedures()
                   throws ManagementException

Gets all procedures objects in this folder from the inventory. If there are none, an empty Procedure array will be returned.

Returns:

procedures in this folder

Throws:

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

getProcedure

Procedure getProcedure(java.lang.String name)
                throws ManagementException

Gets a procedure object, containing its name, text and its metadata from the inventory.

Parameters:

name - the procedure's name

Returns:

the procedure with the given name in this folder or null if there aren't any.

Throws:

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

createProcedureArgument

Argument createProcedureArgument(java.lang.String description,
                                 java.lang.String type,
                                 java.lang.String[] values)

Creates a new instance of Argument type. The created argument is used in the method setArguments with other arguments be set to a procedure.

Parameters:

description - the user description of the argument

type - the type of the description; types are listed in Argument interface

values - will be set if the type is equal to Argument.ENUMERATED_TYPE

Returns:

the created argument

parseProcedureText

int parseProcedureText(java.lang.String text)
                throws ManagementException

Parses the given procedure text to extract all procedure parameters. A parameter in the procedure text is represented as % symbol followed by a number.

Parameters:

text - the procedure text to be parsed

Returns:

0 if there is no parameter in the procedure text and the maximum argument number otherwise

Throws:

ManagementException - if there is a % symbol, followed by incorrect number (every number which is not integer and greater than zero) or the logged user does not imply the proper role.

importInventory

void importInventory(java.io.InputStream in)
              throws ManagementException

Imports the saved procedures from a file in this folder.

Parameters:

in - the InputStream of the file where the procedures are previously exported.

Throws:

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

exportInventory

void exportInventory(java.io.OutputStream out)
              throws ManagementException

Exports the content of the folder into a Java Archive file. Saves the info for all procedures in an entry called procedures.txt. If there are icons for some of the procedures, they are also saved as entries in the JAR file.

Parameters:

out - the output to which the content is written.

Throws:

ManagementException

exportProcedures

void exportProcedures(Folder[] folders,
                      Procedure[] procedures,
                      java.io.OutputStream out)
               throws ManagementException

Exports the content of the given folders and procedures as a ZIP archive file. The method ignores all folders and procedures from the listed ones, which are not direct inheritor of this folder.

Parameters:

folders - the folders which content to be exported

procedures - the procedures to be exported

out - the output where the content is written

Throws:

ManagementException

moveTo

void moveTo(java.lang.String targetFolderPath,
            boolean replace)
     throws ManagementException

Move this folder to the specified one. If there is a folder in the target one with the same name and the replace argument has value false a ManagementExeption will be thrown. Otherwise the folder will be replaced with the moved one. If the folder is successfully moved an event will be generated with type ProcedureEvent.FOLDER_MOVED and it contains the moved folder as source available via getSource(), and the old full path of the moved folder.

Parameters:

targetFolderPath - the path of the folder where the procedure to be moved to.

replace - specifies whether it will be replaced, if there is an existing folder with such path exists

Throws:

ManagementException - If a system error occurs, a folder with the specified path does not exist or the logged user does not imply the proper role