com.groiss.wf
Interface ApplicationAdapter

All Superinterfaces:

HasResource

All Known Implementing Classes:

DefaultApplicationAdapter

public interface ApplicationAdapter
extends HasResource

Interface for classes customizing the application behaviour. your implementation will be used for an application if it is registered in the application administration as application class.

Method Summary

Right	getFinishRight(ActivityInstance ai) Returns the right which is needed for sending the process to next agent The system checks if the sending user has this right for the agent and org.-unit of the given ai.
java.util.List<Right>	getFinishRights() Return the list of finish rights used in this application.
java.lang.String	getNewProcessId(ProcessInstance pi) The method is called whenever a new process Id is needed
com.groiss.wf.distri.Packer	getPacker() Return the Packer used for distributing activities of this application.
java.util.List<org.jdom.Element>	getUserProperties(User u) Returns the user properties a user can set.
java.lang.String	getVersion() Returns the version of the application code.
void	modifyDetailLinks(KeyedList<java.lang.String,Link> links, java.lang.StringBuilder title, ProcessInstance pi, ActivityInstance ai) You can modify the title and links in the detail view of the process.
void	notifyUser(User u, ActivityInstance ai) The method is called when an email-notification about a new worklist entry is sent.
void	onAbort(ProcessInstance pi) A process is aborted
void	onAddDocument(ProcessInstance pi, DMSFolder f, DMSObject o) Called when a document is added to a process of this application.
void	onChangeAgent(ActivityInstance oldAi, ActivityInstance newAi) An ActivityInstance is taken out of the suspension list.
void	onReactivate(ProcessInstance pi) A process is reactivated
void	onRemoveDocument(ProcessInstance pi, DMSFolder f, DMSObject o) Called when a document is removed from a process of this application.
void	onSeeAgain(ActivityInstance ai) An ActivityInstance is taken out of the suspension list.
void	onSeeLater(ActivityInstance ai) An ActivityInstance is put into the suspension list.
java.lang.String	upgrade(Application appl) The method is called when the application server detects that the version of the application in the database is different from the version of the code.

Methods inherited from interface com.groiss.org.HasResource

getResource, localizeNames, setApplication

Method Detail

getNewProcessId

java.lang.String getNewProcessId(ProcessInstance pi)

The method is called whenever a new process Id is needed

Parameters:

pi - the process instance for which the id should be generated

onSeeLater

void onSeeLater(ActivityInstance ai)

An ActivityInstance is put into the suspension list.

Parameters:

ai - an activity instance

onSeeAgain

void onSeeAgain(ActivityInstance ai)

An ActivityInstance is taken out of the suspension list.

Parameters:

ai - an activity instance

onChangeAgent

void onChangeAgent(ActivityInstance oldAi,
                   ActivityInstance newAi)

An ActivityInstance is taken out of the suspension list.

Parameters:

oldAi - the old activity instance

newAi - the new activity instance

onAbort

void onAbort(ProcessInstance pi)

A process is aborted

Parameters:

pi - the process instance

onReactivate

void onReactivate(ProcessInstance pi)

A process is reactivated

Parameters:

pi - the process instance

onAddDocument

void onAddDocument(ProcessInstance pi,
                   DMSFolder f,
                   DMSObject o)

Called when a document is added to a process of this application.

Parameters:

pi - the process instance

f - the folder where the object will be added

o - the object to add

onRemoveDocument

void onRemoveDocument(ProcessInstance pi,
                      DMSFolder f,
                      DMSObject o)

Called when a document is removed from a process of this application.

Parameters:

pi - the process instance

f - the folder

o - the object to add

notifyUser

void notifyUser(User u,
                ActivityInstance ai)

The method is called when an email-notification about a new worklist entry is sent.

Parameters:

u - the recipient

ai - an activity instance

getUserProperties

java.util.List<org.jdom.Element> getUserProperties(User u)

Returns the user properties a user can set. It is normally read from the application configuration.

Parameters:

u - The user whose properties should be returned

Returns:

a list of jdom elements describing the property.

getFinishRight

Right getFinishRight(ActivityInstance ai)

Returns the right which is needed for sending the process to next agent The system checks if the sending user has this right for the agent and org.-unit of the given ai.

Parameters:

ai - the new ActivityInstance

getFinishRights

java.util.List<Right> getFinishRights()

Return the list of finish rights used in this application.

Returns:

a List of rights

getPacker

com.groiss.wf.distri.Packer getPacker()

Return the Packer used for distributing activities of this application.

Returns:

a Packer object

modifyDetailLinks

void modifyDetailLinks(KeyedList<java.lang.String,Link> links,
                       java.lang.StringBuilder title,
                       ProcessInstance pi,
                       ActivityInstance ai)

You can modify the title and links in the detail view of the process.

Parameters:

links - a keyed list of Link objects, keys are form{i}, documents, notes, history, process

title -

pi - the process instance

ai - the activity instance, may be null (for example when called from search)

getVersion

java.lang.String getVersion()

Returns the version of the application code. The returning string is compared to the version in the database when the system starts up in restricted mode.

Returns:

the version string

upgrade

java.lang.String upgrade(Application appl)
                         throws java.lang.Exception

The method is called when the application server detects that the version of the application in the database is different from the version of the code.

Throws:

java.lang.Exception