com.prosyst.mprm.admin.procedures

Interface ProcedureEvent

All Superinterfaces:

Externalizable

public interface ProcedureEvent
extends Externalizable

Holds information about change of a procedure or folder, which has been occurred in the procedure inventory.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TYPE Event type for the procedures changes.
static int	FOLDER_ADDED A constant used for event type to specify that a folder is added.
static int	FOLDER_MOVED A constant used for event type to specify that a folder is moved.
static int	FOLDER_REMOVED A constant used for event type to specify that a folder is removed.
static int	PROCEDURE_ADDED A constant used for event type to specify that a procedure is added.
static int	PROCEDURE_MODIFIED A constant used for event type to specify that a procedure is changed.
static int	PROCEDURE_MOVED A constant used for event type to specify that a procedure is moved.
static int	PROCEDURE_REMOVED A constant used for event type to specify that a procedure is removed.
static int	PROCEDURE_RENAMED A constant used for event type to specify that a procedure is renamed.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the previous name of the renamed/removed procedure.
java.lang.String	getPath() Returns the previous path of the procedure or folder.
java.lang.Object	getSource() Returns the changed/added object.
int	getType() Returns the type of the event.

Methods inherited from interface com.prosyst.util.io.Externalizable

readObject, writeObject

Field Detail

EVENT_TYPE

static final java.lang.String EVENT_TYPE

Event type for the procedures changes.

See Also:

Constant Field Values

PROCEDURE_ADDED

static final int PROCEDURE_ADDED

A constant used for event type to specify that a procedure is added. It shall be thrown when a single procedure is added. The method getSource() shall return the added procedure. All the other methods shall return null values. When a procedure is moved other type of event shall be generated.

See Also:

Constant Field Values

PROCEDURE_REMOVED

static final int PROCEDURE_REMOVED

A constant used for event type to specify that a procedure is removed. It shall be thrown when a single procedure is removed. The method getPath() shall return the path of the removed procedure and the method getName() shall return its name. All the other methods shall return null values.

See Also:

Constant Field Values

PROCEDURE_MODIFIED

static final int PROCEDURE_MODIFIED

A constant used for event type to specify that a procedure is changed. If a procedure is changed the method getSource() shall return the changed procedure. Events with this type will be generated when an existing procedure is changed. Its text, arguments, shortcut, icon can be changed. In this case getSource() shall return the modified procedure object and all the other methods shall return null.

See Also:

Constant Field Values

PROCEDURE_RENAMED

static final int PROCEDURE_RENAMED

A constant used for event type to specify that a procedure is renamed. If a procedure is renamed the method getName() will return the old name of the procedure and the method getSource() will return the actual procedure with its new name. Otherwise the method getName() will return null.

See Also:

Constant Field Values

PROCEDURE_MOVED

static final int PROCEDURE_MOVED

A constant used for event type to specify that a procedure is moved. If a procedure is moved the method getPath() will return the old path of the procedure and the method getSource() will return the moved procedure with its new path. The method getName() will return null.

See Also:

Constant Field Values

FOLDER_ADDED

static final int FOLDER_ADDED

A constant used for event type to specify that a folder is added. If a folder is added the methods getPath() and getName() will return null and the method getSource() shall return the added folder.

See Also:

Constant Field Values

FOLDER_REMOVED

static final int FOLDER_REMOVED

A constant used for event type to specify that a folder is removed. If a folder is removed the method getPath() shall return the full path of the removed folder and the method getSource() will return null. In this case there are no events generated for all the procedures and folders which this folder contains.

See Also:

Constant Field Values

FOLDER_MOVED

static final int FOLDER_MOVED

A constant used for event type to specify that a folder is moved. If a folder is moved the method getPath() shall return the previous full path of the moved folder and the method getSource() shall return the folder with its new path. In this case there are no events generated for the moved procedures/folders children of this folder.

See Also:

Constant Field Values

Method Detail

getType

int getType()

Returns the type of the event. The possible values are the integer constants declared above.

Returns:

the type of the event.

getPath

java.lang.String getPath()

Returns the previous path of the procedure or folder. It has non-null value if a folder/procedure is moved/removed. The path shall be available from the source using getSource() method.

Returns:

the previous path of the changed procedure/folder

getName

java.lang.String getName()

Returns the previous name of the renamed/removed procedure. The value shall be different from null when a procedure has been removed or renamed.

Returns:

the previous name of renamed procedure or the name of the removed one

getSource

java.lang.Object getSource()

Returns the changed/added object. The source object is an instance of com.prosyst.mprm.admin.procedures.Procedure if the event is 'procedure' oriented, com.prosyst.mprm.admin.procedures.Folder if a folder is changed or null in the case of removal.

Returns:

the moved/added/changed procedure/folder or null in case of removal