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

All Superinterfaces:
OwFieldProvider, OwObject, OwObjectReference

public interface OwWorkitemContainer
extends OwObject

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.ecm.OwObjectReference
OBJECT_TYPE_ALL_CONTAINER_OBJECTS, OBJECT_TYPE_ALL_CONTENT_OBJECTS, OBJECT_TYPE_ALL_TUPLE_OBJECTS, OBJECT_TYPE_ALL_WORKFLOW_OBJECTS, OBJECT_TYPE_BPM_ROOT_FOLDER, OBJECT_TYPE_CONTAINER_USER_START, OBJECT_TYPE_CONTENT_USER_START, OBJECT_TYPE_CROSS_QUEUE_FOLDER, OBJECT_TYPE_CUSTOM, OBJECT_TYPE_DOCUMENT, OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER, OBJECT_TYPE_ECM_ROOT_FOLDER, OBJECT_TYPE_FOLDER, OBJECT_TYPE_HISTORY, OBJECT_TYPE_LINK, OBJECT_TYPE_PROXY_QUEUE_FOLDER, OBJECT_TYPE_PUBLIC_QUEUE_FOLDER, OBJECT_TYPE_ROSTER_FOLDER, OBJECT_TYPE_ROSTERITEM, OBJECT_TYPE_STORED_SEARCH, OBJECT_TYPE_SYS_QUEUE_FOLDER, OBJECT_TYPE_TRACKER_QUEUE_FOLDER, OBJECT_TYPE_TUPLE_USER_START, OBJECT_TYPE_UNDEFINED, OBJECT_TYPE_USER_QUEUE_FOLDER, OBJECT_TYPE_VIRTUAL_FOLDER, OBJECT_TYPE_WORKFLOW_USER_START, OBJECT_TYPE_WORKITEM, OBJECT_TYPE_WORKITEM_PROXY, OBJECT_TYPE_WORKITEM_TRACKER
 
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.OwObject
add, canAdd, canChangeClass, canDelete, canFilterChilds, canGetContent, canGetPermissions, canGetProperties, canLock, canMove, canRemoveReference, canSetContent, canSetPermissions, canSetProperties, changeClass, delete, getChildCount, getChilds, getClassName, getClonedPermissions, getClonedProperties, getColumnInfoList, getContentCollection, getFilterProperties, getLock, getLockUserID, getMyLock, getNativeObject, getObjectClass, getParents, getPath, getPermissions, getProperties, getProperty, getResource, getSearchTemplate, getVersion, getVersionSeries, hasChilds, hasVersionSeries, move, refreshProperties, refreshProperties, removeReference, setContentCollection, setLock, setPermissions, setProperties, setProperties
 
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

FILTER_TYPE_NONE

static final int FILTER_TYPE_NONE
filter type for disabled filter, used in getChilds, see also setFilter

See Also:
Constant Field Values

FILTER_TYPE_RESUBMISSION

static final int FILTER_TYPE_RESUBMISSION
filter type to retrieve only items which are resubmitted with the OwBPMWorkItem.resubmit() function, used in getChilds, see also setFilter

See Also:
Constant Field Values

FILTER_TYPE_NORMAL

static final int FILTER_TYPE_NORMAL
filter type to retrieve only items which are NOT resubmitted (default), used in getChilds, see also setFilter

See Also:
Constant Field Values

GROUPBOX_PROPERTY_NAME

static final String GROUPBOX_PROPERTY_NAME
(optional) property name for the groupboxes, can be used to distinguish groupboxes in cross views

See Also:
Constant Field Values
Method Detail

canResubmit

boolean canResubmit()
                    throws Exception
check if resubmission is supported by the queue

Throws:
Exception

setFilterType

void setFilterType(int iFilterType_p)
set a filter to filter specific items in getChilds in addition to the getChilds OwSearchNode parameter

Parameters:
iFilterType_p - int as defined in FILTER_TYPE_...

getFilterType

int getFilterType()
get a filter to filter specific items in getChilds in addition to the getChilds OwSearchNode parameter

Returns:
int as defined in FILTER_TYPE_...

getPublicReassignContainerNames

Collection getPublicReassignContainerNames()
                                           throws Exception
get the possible reassign container names used in reassignToPublicContainer

Returns:
Collection of names or null if not defined
Throws:
Exception

getPublicReassignContainerDisplayName

String getPublicReassignContainerDisplayName(String sName_p)
get a display name for a reassign container name used in reassignToPublicContainer


canPull

boolean canPull(int iContext_p)
                throws Exception,
                       OwStatusContextException
check if container supports work item pull, see pull

Parameters:
iContext_p - int OwStatusContextDefinitions
Returns:
boolean
Throws:
Exception
OwStatusContextException

pull

OwWorkitem pull(OwSort sort_p,
                Set exclude_p)
                throws Exception,
                       OwObjectNotFoundException,
                       OwServerException
pulls the next available work item out of the container and locks it for the user

Parameters:
sort_p - OwSort optional sorts the items and takes the first available one, can be null
exclude_p - Set of work item DMSIDs to be excluded, can be null
Returns:
OwWorkitem or OwObjectNotFoundException if no object is available or OwServerException if no object could be pulled within timeout
Throws:
Exception - for general error or OwServerException if timed out or OwObjectNotFoundException if no work item is available
OwObjectNotFoundException
OwServerException

getDefaultUsers

Collection getDefaultUsers()
get a collection of users that should be offered to the users for reassignment

Returns:
Collection of OwUserInfo or null if no default list is available
Since:
2.5.2.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.