com.tibco.bpm.web.client.services.actions.workitems
Class OpenNextWorkItem

java.lang.Object
  com.tibco.bpm.web.client.services.actions.workitems.OpenNextWorkItem

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, OSAction<WorkItemResult>, net.customware.gwt.dispatch.shared.Action<WorkItemResult>

public class OpenNextWorkItem
extends java.lang.Object
implements OSAction<WorkItemResult>

Open the next available Work Item for the user.

Throws an ActionException if no items are available or an error occurs.

©2011 TIBCO Software Inc.

Since:

1.2.0

See Also:

WorkItemResult

Constructor Summary

OpenNextWorkItem(java.lang.String channelId, java.lang.String channelType, java.lang.String userId, long workListViewId)
Constructs a new OpenNextWorkItem Action.

Method Summary

java.lang.String	getChannelId() Channel ID, for GWT clients this is typically :
java.lang.String	getChannelType() Channel Type, for GWT clients this is typically :
java.lang.String	getUserId() User ID ( GUID ) of the user opening the Work Item.
long	getWorkListViewId() Work List View ID of the BRM view to use when calling open next.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenNextWorkItem

public OpenNextWorkItem(java.lang.String channelId,
                        java.lang.String channelType,
                        java.lang.String userId,
                        long workListViewId)

Constructs a new OpenNextWorkItem Action.

Parameters:

channelId - Channel ID, for GWT clients this is typically :

"openspaceGWTPull_DefaultChannel"

channelType - Channel Type, for GWT clients this is typically :

"GWTChannel"

userId - User ID ( GUID ) of the user opening the Work Item.

workListViewID - ID of the WorkListView in BRM to use for the Open Next request.

Method Detail

getChannelId

public java.lang.String getChannelId()

Channel ID, for GWT clients this is typically :

"openspaceGWTPull_DefaultChannel"

Returns:

Returns the channelId.

getChannelType

public java.lang.String getChannelType()

Channel Type, for GWT clients this is typically :

"GWTChannel"

Returns:

Returns the channelType.

getUserId

public java.lang.String getUserId()

User ID ( GUID ) of the user opening the Work Item.

Returns:

Returns the userId.

getWorkListViewId

public long getWorkListViewId()

Work List View ID of the BRM view to use when calling open next.

Returns:

Returns the Work List View ID.