|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OwWorkitemContainer
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
Field Summary | |
---|---|
static int |
FILTER_TYPE_NONE
filter type for disabled filter, used in getChilds, see also setFilter |
static int |
FILTER_TYPE_NORMAL
filter type to retrieve only items which are NOT resubmitted (default), used in getChilds, see also setFilter |
static int |
FILTER_TYPE_RESUBMISSION
filter type to retrieve only items which are resubmitted with the OwBPMWorkItem.resubmit() function, used in getChilds, see also setFilter |
static String |
GROUPBOX_PROPERTY_NAME
(optional) property name for the groupboxes, can be used to distinguish groupboxes in cross views |
Fields inherited from interface com.wewebu.ow.server.ecm.OwObject |
---|
STANDARD_PATH_DELIMITER |
Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider |
---|
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL |
Method Summary | |
---|---|
boolean |
canPull(int iContext_p)
check if container supports work item pull, see pull |
boolean |
canResubmit()
check if resubmission is supported by the queue |
Collection |
getDefaultUsers()
get a collection of users that should be offered to the users for reassignment |
int |
getFilterType()
get a filter to filter specific items in getChilds in addition to the getChilds OwSearchNode parameter |
String |
getPublicReassignContainerDisplayName(String sName_p)
get a display name for a reassign container name used in reassignToPublicContainer |
Collection |
getPublicReassignContainerNames()
get the possible reassign container names used in reassignToPublicContainer |
OwWorkitem |
pull(OwSort sort_p,
Set exclude_p)
pulls the next available work item out of the container and locks it for the user |
void |
setFilterType(int iFilterType_p)
set a filter to filter specific items in getChilds in addition to the getChilds OwSearchNode parameter |
Methods inherited from interface com.wewebu.ow.server.ecm.OwObjectReference |
---|
getDMSID, getID, getInstance, getMIMEParameter, getMIMEType, getName, getPageCount, getResourceID, getType, hasContent |
Methods inherited from interface com.wewebu.ow.server.field.OwFieldProvider |
---|
getField, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getSafeFieldValue, setField |
Field Detail |
---|
static final int FILTER_TYPE_NONE
static final int FILTER_TYPE_RESUBMISSION
static final int FILTER_TYPE_NORMAL
static final String GROUPBOX_PROPERTY_NAME
Method Detail |
---|
boolean canResubmit() throws Exception
Exception
void setFilterType(int iFilterType_p)
iFilterType_p
- int as defined in FILTER_TYPE_...int getFilterType()
Collection getPublicReassignContainerNames() throws Exception
Exception
String getPublicReassignContainerDisplayName(String sName_p)
boolean canPull(int iContext_p) throws Exception, OwStatusContextException
iContext_p
- int OwStatusContextDefinitions
Exception
OwStatusContextException
OwWorkitem pull(OwSort sort_p, Set exclude_p) throws Exception, OwObjectNotFoundException, OwServerException
sort_p
- OwSort optional sorts the items and takes the first available one, can be nullexclude_p
- Set of work item DMSIDs to be excluded, can be null
Exception
- for general error or OwServerException if timed out or OwObjectNotFoundException if no work item is available
OwObjectNotFoundException
OwServerException
Collection getDefaultUsers()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |