public interface OwWorkitemRepository<W extends OwWorkitem> extends OwRepository<W>
Base interface for Workitem containers, or BPM Queues.
To be implemented with the specific BPM system.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Interface and Description |
---|---|
static class |
OwWorkitemRepository.OwContainerPrefixMapSingleton
Singleton that maps BPM container prefixes to types,
used to organize the different container types for configuration,
e.g.
|
static interface |
OwWorkitemRepository.OwProxyInfo
Proxy object information.
|
Modifier and Type | Field and Description |
---|---|
static OwWorkitemRepository.OwContainerPrefixMapSingleton |
m_containerprefixmap
singleton that maps queuecontainer prefixes to types,
used to organize the different queue types for configuration,
e.g.
|
static String |
PATH_DELIMITER
delimiter used to build paths and structure the containers into folders and subfolders,
see also m_containerprefixmap
|
Modifier and Type | Method and Description |
---|---|
boolean |
canLaunch()
check if repository supports the creation of launchable items.
The actual launching of items is performed by calling the dispatch method of a launchable item. |
boolean |
canProxy()
check if repository allows proxy settings
|
OwWorkitem |
createLaunchableItem(OwWorkflowDescription workflowDescription_p,
Collection attachmentobjects_p)
create a temporary work item for the given workflow ID that can be edited in a launch processor
NOTE: The item is not launched until its dispatch method is called.
|
OwWorkitemRepository.OwProxyInfo |
createProxy()
create a new proxy info used in setProxies
|
Collection |
getLaunchableWorkflowDescriptions(Collection attachmentobjects_p)
get a collection of
OwWorkflowDescription s for the launchable workflows in the repository. |
Collection |
getProxies(String absentpersonID_p)
get proxy info for given absent person
|
OwWorkitemContainer |
getWorkitemContainer(String sID_p,
int iType_p)
get a OwWorkitemContainer wrapper for the given container name
|
Collection |
getWorkitemContainerIDs(boolean fRefresh_p,
int iType_p)
get a collection of ID's for each container
|
String |
getWorkitemContainerName(String sID_p,
int iType_p)
get a displayname for the given container name
|
boolean |
hasContainer(int iType_p)
check if containers are available
|
void |
setProxies(Collection proxies_p,
String absentpersonID_p)
set proxies, to receive the workitems
NOTE: All existing proxies for the given absent person will be deleted
|
canBatch, canPageSearch, canRefreshStaticClassdescriptions, closeBatch, doSearch, doSearch, getDMSPrefix, getEventManager, getObjectClass, getObjectClassNames, getObjectFromDMSID, getObjectFromPath, getResource, getResourceIDs, openBatch, refreshStaticClassdescriptions, releaseResources
getFieldDefinition, getWildCardDefinitions
static final String PATH_DELIMITER
static final OwWorkitemRepository.OwContainerPrefixMapSingleton m_containerprefixmap
Collection getWorkitemContainerIDs(boolean fRefresh_p, int iType_p) throws Exception
fRefresh_p
- boolean true = update collection from serveriType_p
- int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...Exception
OwWorkitemContainer getWorkitemContainer(String sID_p, int iType_p) throws Exception
sID_p
- String ID of containeriType_p
- int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...Exception
String getWorkitemContainerName(String sID_p, int iType_p) throws Exception
sID_p
- String ID of containeriType_p
- int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...Exception
boolean hasContainer(int iType_p) throws Exception
iType_p
- int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...Exception
OwWorkitemRepository.OwProxyInfo createProxy() throws Exception, OwNotSupportedException
Exception
OwNotSupportedException
void setProxies(Collection proxies_p, String absentpersonID_p) throws Exception, OwNotSupportedException
proxies_p
- Collection of OwProxyInfoabsentpersonID_p
- String the person which is absentException
OwNotSupportedException
Collection getProxies(String absentpersonID_p) throws Exception, OwNotSupportedException
absentpersonID_p
- String ID of absent personException
OwNotSupportedException
boolean canProxy()
Collection getLaunchableWorkflowDescriptions(Collection attachmentobjects_p) throws Exception
OwWorkflowDescription
s for the launchable workflows in the repository.
The returned list describes only those workflows
the user has appropriate access right's / roles to launch the workflow.
If attachmentobjects_p are submitted, the method will only return those workflow descriptions,
which can accept the given OwObject's as initial attachments.attachmentobjects_p
- optional collection of attachment OwObject's, can be nullException
OwWorkitem createLaunchableItem(OwWorkflowDescription workflowDescription_p, Collection attachmentobjects_p) throws Exception
workflowDescription_p
- the description of the workflow to launchattachmentobjects_p
- optional collection of attachment OwObject's, can be nullException
OwWorkitem.dispatch()
boolean canLaunch()
createLaunchableItem(OwWorkflowDescription, Collection)
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.