public interface ApplicationAdapter extends HasResource
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
void |
getToolbarActions(ActivityInstance ai,
java.util.List<Pair<java.lang.String,java.util.List<Pair<java.lang.String,?>>>> actions)
Determine the toolbar actions shown in the detail view of an activity instance.
|
java.util.List<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 |
modifyDetailPanes(KeyedList<java.lang.String,NavigationTreeNode> nodes,
java.lang.StringBuilder title,
ProcessInstance pi,
ActivityInstance ai)
You can modify the title and tabs 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)
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 |
onChangeAgent(ActivityInstance oldAi,
ActivityInstance newAi)
Change agent has been performed for an activity instance.
|
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.
|
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.
|
getResource, localizeNames, setApplication
java.lang.String getNewProcessId(ProcessInstance pi)
pi
- the process instance for which the id should be generatedvoid onSeeLater(ActivityInstance ai)
ai
- an activity instancevoid onSeeAgain(ActivityInstance ai)
ai
- an activity instancevoid onChangeAgent(ActivityInstance oldAi, ActivityInstance newAi)
oldAi
- the old activity instancenewAi
- the new activity instancevoid onAbort(ProcessInstance pi)
pi
- the aborted activity instance, may be a process instance, may be an activity instancevoid onReactivate(ProcessInstance pi)
pi
- the process instancevoid onAddDocument(ProcessInstance pi, DMSFolder f, DMSObject o)
pi
- the process instancef
- the folder where the object will be addedo
- the object to addvoid onRemoveDocument(ProcessInstance pi, DMSFolder f, DMSObject o)
pi
- the process instancef
- the foldero
- the object to addvoid notifyUser(User u, ActivityInstance ai)
u
- the recipientai
- an activity instancejava.util.List<Element> getUserProperties(User u)
u
- The user whose properties should be returnedRight getFinishRight(ActivityInstance ai)
ai
- the new ActivityInstancejava.util.List<Right> getFinishRights()
com.groiss.wf.distri.Packer getPacker()
void modifyDetailLinks(KeyedList<java.lang.String,Link> links, java.lang.StringBuilder title, ProcessInstance pi, ActivityInstance ai)
links
- a keyed list of Link objects, keys are 'form<index>', 'documents', 'notes', 'history', 'process'title
- pi
- the process instanceai
- the activity instance, may be null (for example when called from search)void modifyDetailPanes(KeyedList<java.lang.String,NavigationTreeNode> nodes, java.lang.StringBuilder title, ProcessInstance pi, ActivityInstance ai)
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
- the title we suggestpi
- process instance objectai
- activity instance object, may be nullvoid getToolbarActions(ActivityInstance ai, java.util.List<Pair<java.lang.String,java.util.List<Pair<java.lang.String,?>>>> actions)
ai
- the activity instanceactions
- the actions configured in the worklistjava.lang.String getVersion()
java.lang.String upgrade(Application appl) throws java.lang.Exception
java.lang.Exception
@enterprise 9.0.33982 Copyright © 2001-2023 Groiss Informatics GmbH. All Rights Reserved.