com.wewebu.ow.server.plug.owbpm
Interface OwBPMVirtualQueue

All Known Implementing Classes:
OwBPMQueue

public interface OwBPMVirtualQueue

Workdesk BPM Plugin.
Interface for all virtual queues.

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


Method Summary
 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
 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()
          get the work item container of that queue
 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 isResubmitFilter()
          check if resubmission filter is on
 void toggleFilter()
          switch filter on or off
 void toggleResubmitFilter()
          switch resubmission view on or off
 

Method Detail

canResubmit

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

Throws:
Exception

getIcon

String getIcon()
               throws Exception
get the path / URL to the icon for the queue

Throws:
Exception

applyRules

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

Parameters:
obj_p - OwObject work item to check for
Returns:
String style class or null of no rule matches

getWorkItems

com.wewebu.ow.server.ecm.OwObjectCollection getWorkItems(com.wewebu.ow.server.field.OwSearchNode filterNode_p)
                                                         throws Exception
get the workitems from the queue

Throws:
Exception

getSort

com.wewebu.ow.server.field.OwSort getSort()
                                          throws Exception
the sort object to use for this queue

Throws:
Exception

getColumnInfo

List getColumnInfo()
                   throws Exception
get the column info for the child list columns

Returns:
List of OwFieldColumnInfo
Throws:
Exception

getObjectListFilter

com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwFilter getObjectListFilter()
                                                                                    throws Exception
get the filter setting

Returns:
OwObjectListViewFilterRow.OwFilter
Throws:
Exception

getName

String getName()
               throws Exception
get the name of the queue

Throws:
Exception

getItemCount

int getItemCount(int context_p)
                 throws Exception
get the number of items in the queue

Parameters:
context_p - int on of OwStatusContextDefinitions.STATUS_CONTEXT_...
Returns:
count or throws OwStatusContextException
Throws:
Exception,OwStatusContextException
Exception

getDisplayName

String getDisplayName()
                      throws Exception
get the name of the queue

Throws:
Exception

getSearchTemplate

com.wewebu.ow.server.field.OwSearchTemplate getSearchTemplate()
                                                              throws Exception
get the search template for the queue

Throws:
Exception

toggleResubmitFilter

void toggleResubmitFilter()
switch resubmission view on or off


isResubmitFilter

boolean isResubmitFilter()
check if resubmission filter is on


toggleFilter

void toggleFilter()
switch filter on or off


enableFilter

void enableFilter(boolean fEnable_p)
switch filter on or off


isFilter

boolean isFilter()
check if filter is enabled


getQueueFolder

com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer getQueueFolder()
get the work item container of that queue



Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.