com.wewebu.ow.server.plug.owbpm

Class OwBPMQueue

java.lang.Object

com.wewebu.ow.server.plug.owbpm.OwBPMQueue

All Implemented Interfaces:

OwBPMVirtualQueue

public class OwBPMQueue
extends Object
implements OwBPMVirtualQueue

Workdesk BPM Plugin.
A BPM queue wrapper.

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

Constructor Summary

Constructors

Constructor and Description
OwBPMQueue(OwBPMDocument doc_p, com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer queueFolder_p, Collection rulelist_p) creates a wrapper for the given queue name
OwBPMQueue(OwBPMDocument doc_p, com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer queueFolder_p, Collection rulelist_p, boolean hideIfEmpty)

Method Summary

Methods

Modifier and Type	Method and Description
String	applyRules(com.wewebu.ow.server.ecm.OwObject obj_p) check if the rules apply to this object so it should be displayed with a color
boolean	canResubmit() check if resubmission is supported by the queue
void	enableFilter(boolean fEnable_p) switch filter on or off
List	getColumnInfo() get the column info for the child list columns
protected com.wewebu.ow.server.app.OwMainAppContext	getContext() get the context
String	getDisplayName() get the name of the queue
String	getIcon() get the path / URL to the icon for the queue
int	getItemCount(int context_p) get the number of items in the queue
String	getName() get the name of the queue
com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwFilter	getObjectListFilter() get the filter setting
com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer	getQueueFolder() the folder object from the repository
com.wewebu.ow.server.field.OwSearchTemplate	getSearchTemplate() get the search template for the queue
com.wewebu.ow.server.field.OwSort	getSort() the sort object to use for this queue
com.wewebu.ow.server.ecm.OwObjectCollection	getWorkItems(com.wewebu.ow.server.field.OwSearchNode filterNode_p) get the workitems from the queue
boolean	isFilter() check if filter is enabled
boolean	isHideIfEmpty() Tells if this queue should be hidden if empty.
boolean	isResubmitFilter() check if resubmission filter is on
void	toggleFilter() switch filter on or off
void	toggleResubmitFilter() switch resubmission view on or off

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OwBPMQueue

public OwBPMQueue(OwBPMDocument doc_p,
          com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer queueFolder_p,
          Collection rulelist_p)

creates a wrapper for the given queue name

Parameters:

doc_p -

queueFolder_p -

rulelist_p - Collection of OwPriorityRule or null of no rules are defined

OwBPMQueue

public OwBPMQueue(OwBPMDocument doc_p,
          com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer queueFolder_p,
          Collection rulelist_p,
          boolean hideIfEmpty)

Method Detail

applyRules

public String applyRules(com.wewebu.ow.server.ecm.OwObject obj_p)

check if the rules apply to this object so it should be displayed with a color

Specified by:

applyRules in interface OwBPMVirtualQueue

Parameters:

obj_p - OwObject work item to check for

Returns:

String style class or null if no rule matches

getQueueFolder

public com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer getQueueFolder()

the folder object from the repository

Specified by:

getQueueFolder in interface OwBPMVirtualQueue

canResubmit

public boolean canResubmit()
                    throws Exception

check if resubmission is supported by the queue

Specified by:

canResubmit in interface OwBPMVirtualQueue

Throws:

Exception

getContext

protected com.wewebu.ow.server.app.OwMainAppContext getContext()

get the context

getWorkItems

public com.wewebu.ow.server.ecm.OwObjectCollection getWorkItems(com.wewebu.ow.server.field.OwSearchNode filterNode_p)
                                                         throws Exception

get the workitems from the queue

Specified by:

getWorkItems in interface OwBPMVirtualQueue

Throws:

Exception

getSort

public com.wewebu.ow.server.field.OwSort getSort()
                                          throws Exception

the sort object to use for this queue

Specified by:

getSort in interface OwBPMVirtualQueue

Throws:

Exception

getObjectListFilter

public com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwFilter getObjectListFilter()
                                                                                    throws Exception

get the filter setting

Specified by:

getObjectListFilter in interface OwBPMVirtualQueue

Returns:

OwObjectListViewFilterRow.OwFilter

Throws:

Exception

getColumnInfo

public List getColumnInfo()
                   throws Exception

get the column info for the child list columns

Specified by:

getColumnInfo in interface OwBPMVirtualQueue

Returns:

List of OwFieldColumnInfo

Throws:

Exception

getName

public String getName()
               throws Exception

get the name of the queue

Specified by:

getName in interface OwBPMVirtualQueue

Throws:

Exception

getItemCount

public int getItemCount(int context_p)
                 throws Exception

get the number of items in the queue

Specified by:

getItemCount in interface OwBPMVirtualQueue

Parameters:

context_p - int on of OwStatusContextDefinitions.STATUS_CONTEXT_...

Returns:

count or throws OwStatusContextException

Throws:

Exception,OwStatusContextException

Exception

getDisplayName

public String getDisplayName()
                      throws Exception

get the name of the queue

Specified by:

getDisplayName in interface OwBPMVirtualQueue

Throws:

Exception

getSearchTemplate

public com.wewebu.ow.server.field.OwSearchTemplate getSearchTemplate()
                                                              throws Exception

get the search template for the queue

Specified by:

getSearchTemplate in interface OwBPMVirtualQueue

Throws:

Exception

getIcon

public String getIcon()
               throws Exception

get the path / URL to the icon for the queue

Specified by:

getIcon in interface OwBPMVirtualQueue

Throws:

Exception

toggleResubmitFilter

public void toggleResubmitFilter()

switch resubmission view on or off

Specified by:

toggleResubmitFilter in interface OwBPMVirtualQueue

isResubmitFilter

public boolean isResubmitFilter()

check if resubmission filter is on

Specified by:

isResubmitFilter in interface OwBPMVirtualQueue

toggleFilter

public void toggleFilter()

switch filter on or off

Specified by:

toggleFilter in interface OwBPMVirtualQueue

enableFilter

public void enableFilter(boolean fEnable_p)

switch filter on or off

Specified by:

enableFilter in interface OwBPMVirtualQueue

isFilter

public boolean isFilter()

check if filter is enabled

Specified by:

isFilter in interface OwBPMVirtualQueue

isHideIfEmpty

public boolean isHideIfEmpty()

Description copied from interface: OwBPMVirtualQueue

Tells if this queue should be hidden if empty.

Specified by:

isHideIfEmpty in interface OwBPMVirtualQueue

Returns:

true if this queue should be hidden if empty.