com.groiss.wf

Class DefaultApplicationAdapter

java.lang.Object

com.groiss.wf.DefaultApplicationAdapter

All Implemented Interfaces:

Lifecycle, Service, HasResource, ApplicationAdapter, com.groiss.wf.DefaultApplicationAdapterInterface

public class DefaultApplicationAdapter
extends Object
implements ApplicationAdapter, Service, com.groiss.wf.DefaultApplicationAdapterInterface

Default implementation for ApplicationAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected Application	appl
protected Resource	applres
static String	ID_PREFIX
protected boolean	localize
protected boolean	running
protected List<Element>	userprops

Constructor Summary

Constructors

Constructor and Description
DefaultApplicationAdapter()

Method Summary

Modifier and Type	Method and Description
static URL	getDescFile(Application appl)
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.
List<Right>	getFinishRights() Return the list of finish rights used in this application.
String	getNewProcessId(ProcessInstance pi) The method is called whenever a new process Id is needed
protected Page	getNotificationMail(User user, ActivityInstance ai) Build the notification mail (default notification strategy for notifyUser(User, ActivityInstance))
protected static HTMLPage	getNotificationMail(User u, ActivityInstance ai, String template) Builds the default notification mail
com.groiss.wf.distri.Packer	getPacker() Return the Packer used for distributing activities of this application.
Resource	getResource()
void	getToolbarActions(ActivityInstance ai, List<Pair<String,List<Pair<String,?>>>> actions) Determine the toolbar actions shown in the detail view of an activity instance.
List<Element>	getUserProperties(User u) Returns the user properties a user can set.
String	getVersion() Returns the version of the application code.
void	internalStartup() Sets up the UserProperties and the resources for proper i18n.
void	internalStartupComplete() Signals that startup is finished.
boolean	isRunning() Ask the object if it has been started
boolean	localizeNames() returns true if the application is the default application or the configuration has a resource file configured.
void	modifyDetailLinks(KeyedList<String,Link> links, StringBuilder title, ProcessInstance pi, ActivityInstance ai) You can modify the title and links in the detail view of the process.
void	modifyDetailPanes(KeyedList<String,NavigationTreeNode> nodes, StringBuilder title, ProcessInstance pi, ActivityInstance ai) You can modify the title and tabs in the detail view of the process.
int	nextNum(String id)
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) An activity is aborted (process is aborted, activity cancelled by goBack)
void	onAddDocument(ProcessInstance pi, DMSFolder f, DMSObject o) Called before a document is added to a process (incl. subfolders) of this application.
void	onAnonymize(User u, String newId) The method is called when the anonymize function is called for a user.
void	onChangeAgent(ActivityInstance oldAi, ActivityInstance newAi) Change agent has been performed for an activity instance.
List<Pair<ActivityInstance,List<ActivityInstance>>>	onListPreviousSteps(ActivityInstance ai, List<Pair<ActivityInstance,List<ActivityInstance>>> list) Called when "go back" is executed.
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 (incl. subfolders) 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.
void	setApplication(Application appl)
void	shutdown() This method is called on shutdown.
void	startup() Called on @enterprise startup.
String	upgrade(Application app) The default implementation of the upgrade method checks the upgrade information in the properties.xml file of the application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.groiss.wf.ApplicationAdapter

onApplicationInstall, onApplicationUninstall, onCopyProcess, onFinishNotComplete

Field Detail

appl

protected Application appl

userprops

protected List<Element> userprops

localize

protected boolean localize

applres

protected Resource applres

running

protected boolean running

ID_PREFIX

public static final String ID_PREFIX

See Also:

Constant Field Values

Constructor Detail

DefaultApplicationAdapter

public DefaultApplicationAdapter()

Method Detail

setApplication

public void setApplication(Application appl)

Specified by:

setApplication in interface HasResource

getNewProcessId

public String getNewProcessId(ProcessInstance pi)

Description copied from interface: ApplicationAdapter

The method is called whenever a new process Id is needed

Specified by:

getNewProcessId in interface ApplicationAdapter

Parameters:

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

nextNum

public int nextNum(String id)

onSeeLater

public void onSeeLater(ActivityInstance ai)

Description copied from interface: ApplicationAdapter

An ActivityInstance is put into the suspension list.

Specified by:

onSeeLater in interface ApplicationAdapter

Parameters:

ai - an activity instance

onSeeAgain

public void onSeeAgain(ActivityInstance ai)

Description copied from interface: ApplicationAdapter

An ActivityInstance is taken out of the suspension list.

Specified by:

onSeeAgain in interface ApplicationAdapter

Parameters:

ai - an activity instance

onChangeAgent

public void onChangeAgent(ActivityInstance oldAi,
                          ActivityInstance newAi)

Description copied from interface: ApplicationAdapter

Change agent has been performed for an activity instance.

Specified by:

onChangeAgent in interface ApplicationAdapter

Parameters:

oldAi - the old activity instance

newAi - the new activity instance

onListPreviousSteps

public List<Pair<ActivityInstance,List<ActivityInstance>>> onListPreviousSteps(ActivityInstance ai,
                                                                               List<Pair<ActivityInstance,List<ActivityInstance>>> list)

Description copied from interface: ApplicationAdapter

Called when "go back" is executed.

Specified by:

onListPreviousSteps in interface ApplicationAdapter

Parameters:

ai - the activity instance the process is currently in

list - a list of Pairs. The first element of the pair is a previous activity instance, the second is a list of activities that must be aborted when going back to this step (for example siblings in a parallelism).

Returns:

the changed (or unchanged) list

onAbort

public void onAbort(ProcessInstance pi)

Description copied from interface: ApplicationAdapter

An activity is aborted (process is aborted, activity cancelled by goBack)

Specified by:

onAbort in interface ApplicationAdapter

Parameters:

pi - the aborted activity instance, may be a process instance, may be an activity instance

onReactivate

public void onReactivate(ProcessInstance pi)

Description copied from interface: ApplicationAdapter

A process is reactivated

Specified by:

onReactivate in interface ApplicationAdapter

Parameters:

pi - the process instance

onAddDocument

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

Description copied from interface: ApplicationAdapter

Called before a document is added to a process (incl. subfolders) of this application.

Specified by:

onAddDocument in interface ApplicationAdapter

Parameters:

pi - the process instance

f - the folder where the object will be added

o - the object to add

onRemoveDocument

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

Description copied from interface: ApplicationAdapter

Called when a document is removed from a process (incl. subfolders) of this application.

Specified by:

onRemoveDocument in interface ApplicationAdapter

Parameters:

pi - the process instance

f - the folder

o - the object to add

getNotificationMail

protected Page getNotificationMail(User user,
                                   ActivityInstance ai)

Build the notification mail (default notification strategy for notifyUser(User, ActivityInstance))

Parameters:

user - the user who will be notified

ai - the ActivityInstance which triggered the notification

Returns:

notifyUser

public void notifyUser(User u,
                       ActivityInstance ai)

Description copied from interface: ApplicationAdapter

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

Specified by:

notifyUser in interface ApplicationAdapter

Parameters:

u - the recipient

ai - an activity instance

getUserProperties

public List<Element> getUserProperties(User u)

Description copied from interface: ApplicationAdapter

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

Specified by:

getUserProperties in interface ApplicationAdapter

Parameters:

u - The user whose properties should be returned

Returns:

a list of jdom elements describing the property.

localizeNames

public boolean localizeNames()

returns true if the application is the default application or the configuration has a resource file configured.

Specified by:

localizeNames in interface HasResource

getResource

public Resource getResource()

Specified by:

getResource in interface HasResource

getFinishRight

public Right getFinishRight(ActivityInstance ai)

Description copied from interface: ApplicationAdapter

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.

Specified by:

getFinishRight in interface ApplicationAdapter

Parameters:

ai - the new ActivityInstance

getFinishRights

public List<Right> getFinishRights()

Description copied from interface: ApplicationAdapter

Return the list of finish rights used in this application.

Specified by:

getFinishRights in interface ApplicationAdapter

Returns:

a List of rights

getPacker

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

Description copied from interface: ApplicationAdapter

Return the Packer used for distributing activities of this application.

Specified by:

getPacker in interface ApplicationAdapter

Returns:

a Packer object

modifyDetailLinks

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

Description copied from interface: ApplicationAdapter

You can modify the title and links in the detail view of the process. NOTE: This method is only used in 8.0 compatibiltiy GUI. This method is called every time the details of an item are to be displayed.

Specified by:

modifyDetailLinks in interface ApplicationAdapter

Parameters:

links - a keyed list of Link objects, keys are 'form<index>', 'documents', 'notes', 'history', 'process'

pi - the process instance

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

modifyDetailPanes

public void modifyDetailPanes(KeyedList<String,NavigationTreeNode> nodes,
                              StringBuilder title,
                              ProcessInstance pi,
                              ActivityInstance ai)

Description copied from interface: ApplicationAdapter

You can modify the title and tabs in the detail view of the process. This method is called when the details of an item are to be displayed. This is not called every time, but rather for the first time and when the gui supposes that the item has been changed.

Specified by:

modifyDetailPanes in interface ApplicationAdapter

Parameters:

nodes - a list of configured nodes, the keys are the node ids, for example 'history'. For forms the keys are 'form:<fid>' where fid is the id of the form in the process. The nodes are copied from the original ones and therefore mutable. Additional attributes can be set via NavigationTreeNode.setAttrib(String, Object).

title - HTML text can be added to the StringBuilder, for getting the standard appearance, use the following structure:
<span class="scPID"><label>Id:</label> <span class="scValue">..id..</span></span>
<span class="scProcess"><label>Process:</label> <span class="scValue">..process name..</span></span>
<span class="scTask"><label>Task:</label> <span class="scValue">..task name..</span></span>
<span class="scSubject"><label>Subject:</label> <span class="scValue">..the subject..</span></span>

ai - activity instance object, may be null

startup

public void startup()

Called on @enterprise startup. Read the properties in the application directory for the application configuration, the application specific user properties and the resource bundle user for translating the application resources. This implementation is empty. Method internalStartup() has been called before startup is being called.

Specified by:

startup in interface Lifecycle

internalStartupComplete

public final void internalStartupComplete()

Signals that startup is finished. The method is called by the ApplicationLoader immediately after the call to startup() has completed.

Specified by:

internalStartupComplete in interface com.groiss.wf.DefaultApplicationAdapterInterface

internalStartup

public final void internalStartup()

Sets up the UserProperties and the resources for proper i18n. The method is called by the ApplicationLoader immediately before the call to startup().

Specified by:

internalStartup in interface com.groiss.wf.DefaultApplicationAdapterInterface

shutdown

public void shutdown()

Description copied from interface: Lifecycle

This method is called on shutdown.

Specified by:

shutdown in interface Lifecycle

isRunning

public boolean isRunning()

Description copied from interface: Service

Ask the object if it has been started

Specified by:

isRunning in interface Service

Returns:

true if running.

getVersion

public String getVersion()

Description copied from interface: ApplicationAdapter

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.

Specified by:

getVersion in interface ApplicationAdapter

Returns:

the version string

upgrade

public String upgrade(Application app)
               throws Exception

The default implementation of the upgrade method checks the upgrade information in the properties.xml file of the application. The methods of the upgrade steps are performed for each entry where "to" is greater than the current version of the application.

Specified by:

upgrade in interface ApplicationAdapter

Parameters:

app - the application object

Throws:

Exception

getDescFile

public static URL getDescFile(Application appl)
                       throws IOException

Throws:

IOException

getNotificationMail

protected static HTMLPage getNotificationMail(User u,
                                              ActivityInstance ai,
                                              String template)

Builds the default notification mail

Parameters:

u - the user who is going to receive this notification

ai - the new ai which triggered the notification

template - the message template path. if the template is null, contrib/NotificationMask.html will be used

Returns:

getToolbarActions

public void getToolbarActions(ActivityInstance ai,
                              List<Pair<String,List<Pair<String,?>>>> actions)

Description copied from interface: ApplicationAdapter

Determine the toolbar actions shown in the detail view of an activity instance.

Specified by:

getToolbarActions in interface ApplicationAdapter

Parameters:

ai - the activity instance

actions - the actions configured in the worklist

onAnonymize

public void onAnonymize(User u,
                        String newId)

Description copied from interface: ApplicationAdapter

The method is called when the anonymize function is called for a user. It allows to add some application specific action for removing the user or user name from the database.

Specified by:

onAnonymize in interface ApplicationAdapter

newId - the id after anonymize