com.wewebu.ow.server.ecm.bpm
Interface OwWorkitemRepository

All Superinterfaces:
OwFieldDefinitionProvider, OwRepository

public interface OwWorkitemRepository
extends OwRepository

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


Nested Class Summary
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.
 
Field Summary
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
 
Method Summary
 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 OwWorkflowDescriptions 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
 
Methods inherited from interface com.wewebu.ow.server.ecm.OwRepository
canBatch, canRefreshStaticClassdescriptions, closeBatch, doSearch, getDMSPrefix, getEventManager, getObjectClass, getObjectClassNames, getObjectFromDMSID, getObjectFromPath, getResource, getResourceIDs, openBatch, refreshStaticClassdescriptions, releaseResources
 
Methods inherited from interface com.wewebu.ow.server.field.OwFieldDefinitionProvider
getFieldDefinition, getWildCardDefinitions
 

Field Detail

PATH_DELIMITER

static final String PATH_DELIMITER
delimiter used to build paths and structure the containers into folders and subfolders, see also m_containerprefixmap

See Also:
Constant Field Values

m_containerprefixmap

static final OwWorkitemRepository.OwContainerPrefixMapSingleton m_containerprefixmap
singleton that maps queuecontainer prefixes to types, used to organize the different queue types for configuration, e.g. search templates or folder structures

Method Detail

getWorkitemContainerIDs

Collection getWorkitemContainerIDs(boolean fRefresh_p,
                                   int iType_p)
                                   throws Exception
get a collection of ID's for each container

Parameters:
fRefresh_p - boolean true = update collection from server
iType_p - int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...
Returns:
Collection of String
Throws:
Exception

getWorkitemContainer

OwWorkitemContainer getWorkitemContainer(String sID_p,
                                         int iType_p)
                                         throws Exception
get a OwWorkitemContainer wrapper for the given container name

Parameters:
sID_p - String ID of container
iType_p - int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...
Returns:
OwWorkitemContainer or throws OwObjectNotFoundException
Throws:
Exception

getWorkitemContainerName

String getWorkitemContainerName(String sID_p,
                                int iType_p)
                                throws Exception
get a displayname for the given container name

Parameters:
sID_p - String ID of container
iType_p - int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...
Returns:
String display name
Throws:
Exception

hasContainer

boolean hasContainer(int iType_p)
                     throws Exception
check if containers are available

Parameters:
iType_p - int Type of the requested container names as defined in OwObjectReference.OBJECT_TYPE_...
Throws:
Exception

createProxy

OwWorkitemRepository.OwProxyInfo createProxy()
                                             throws Exception,
                                                    OwNotSupportedException
create a new proxy info used in setProxies

Throws:
Exception
OwNotSupportedException

setProxies

void setProxies(Collection proxies_p,
                String absentpersonID_p)
                throws Exception,
                       OwNotSupportedException
set proxies, to receive the workitems NOTE: All existing proxies for the given absent person will be deleted

Parameters:
proxies_p - Collection of OwProxyInfo
absentpersonID_p - String the person which is absent
Throws:
Exception
OwNotSupportedException

getProxies

Collection getProxies(String absentpersonID_p)
                      throws Exception,
                             OwNotSupportedException
get proxy info for given absent person

Parameters:
absentpersonID_p - String ID of absent person
Returns:
Collection of OwProxyInfo
Throws:
Exception
OwNotSupportedException

canProxy

boolean canProxy()
check if repository allows proxy settings

Returns:
boolean true = allows proxy users to be set

getLaunchableWorkflowDescriptions

Collection getLaunchableWorkflowDescriptions(Collection attachmentobjects_p)
                                             throws Exception
get a collection of OwWorkflowDescriptions 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.

Parameters:
attachmentobjects_p - optional collection of attachment OwObject's, can be null
Returns:
Collection of OwWorkflowDescription or null if no launch workflows are available
Throws:
Exception

createLaunchableItem

OwWorkitem createLaunchableItem(OwWorkflowDescription workflowDescription_p,
                                Collection attachmentobjects_p)
                                throws Exception
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.

Parameters:
workflowDescription_p - the description of the workflow to launch
attachmentobjects_p - optional collection of attachment OwObject's, can be null
Returns:
OwWorkitem
Throws:
Exception
See Also:
OwWorkitem.dispatch()

canLaunch

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.

Returns:
boolean
See Also:
createLaunchableItem(OwWorkflowDescription, Collection)


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.