com.tibco.bpm.service.connector

Class WorkItemManagementService

java.lang.Object

com.tibco.bpm.service.connector.WorkItemManagementService

All Implemented Interfaces:

WorkItemManagementService

public class WorkItemManagementService
extends java.lang.Object
implements WorkItemManagementService

Provides access to the WorkItemManagementService interfaces.

©2011 TIBCO Software Inc.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
com.tibco.n2.brm.api.WorkItem	allocateAndOpenNextWorkItem(java.lang.String resourceId) Allocates and opens the next work item
com.tibco.n2.brm.api.WorkItem[]	allocateAndOpenWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds, java.lang.String[] resources) Allocates and opens a list of work items
com.tibco.n2.brm.api.WorkItem[]	allocateWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds, java.lang.String[] resources) Allocates a list of work items
com.tibco.n2.brm.api.ManagedObjectID[]	closeWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds) Closes a list of work items.
com.tibco.n2.brm.api.CompleteWorkItemResponseDocument.CompleteWorkItemResponse	completeWorkItem(com.tibco.n2.brm.api.ManagedObjectID workItemId, com.tibco.n2.brm.api.WorkItemBody workItemPayload, boolean getNextPiledItem) Allocates and opens the next work item
java.lang.String[]	getOfferSet(com.tibco.n2.brm.api.ManagedObjectID workItemId) Returns s list of resource guids for which the work item was originally offered.
com.tibco.n2.common.organisation.api.XmlModelEntityId[]	getOfferSetV2(com.tibco.n2.brm.api.ManagedObjectID workItemId, int apiVersion) Returns an array of resource Model Entity IDs for which the work item was originally offered.
com.tibco.n2.brm.api.WorkItemHeader[]	getWorkItemHeader(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds) Gets a list of work item headers for the supplied list of work item objects.
com.tibco.n2.brm.api.WorkItemBody[]	openWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds) Opens a work item
com.tibco.n2.brm.api.ManagedObjectID[]	pendWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds, com.tibco.n2.brm.api.HiddenPeriod[] hiddenPeriods) Pends a list of work items.
com.tibco.n2.brm.api.WorkItem[]	reallocateWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds, java.lang.String[] resources, boolean[] revertData) Reallocates a list of work items.
com.tibco.n2.brm.api.WorkItem[]	reallocateWorkItemData(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds, java.lang.String[] resources, com.tibco.n2.brm.api.WorkItemBody[] workItemPayload) Reallocates a list of work items data.
com.tibco.n2.brm.api.ManagedObjectID	saveOpenWorkItem(com.tibco.n2.brm.api.ManagedObjectID workItemId, com.tibco.n2.brm.api.WorkItemBody payload) Saves an open work item
com.tibco.n2.brm.api.ManagedObjectID[]	setWorkItemPriority(com.tibco.n2.brm.api.SetWorkItemPriority.WorkItemIDandPriority[] workItemIDsandPrioritiesArray) Closes a list of work items.
boolean	skipWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds) Skips the supplied list of managed work item objects.
com.tibco.n2.brm.api.WorkItem[]	unallocateWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds) Unallocates a list of work items.

Methods inherited from class java.lang.Object

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

Method Detail

pendWorkItem

public com.tibco.n2.brm.api.ManagedObjectID[] pendWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds,
                                                           com.tibco.n2.brm.api.HiddenPeriod[] hiddenPeriods)
                                                    throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                           com.tibco.n2.brm.services.WorkItemFault,
                                                           com.tibco.n2.brm.services.InvalidVersionFault,
                                                           com.tibco.n2.brm.services.InternalServiceFault,
                                                           com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault,
                                                           com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Pends a list of work items.

Specified by:

pendWorkItem in interface WorkItemManagementService

Returns:

returns an array of work item managed objects throws RuntimeException

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault

com.tibco.n2.brm.services.SecurityFault

closeWorkItem

public com.tibco.n2.brm.api.ManagedObjectID[] closeWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds)
                                                     throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                            com.tibco.n2.brm.services.WorkItemFault,
                                                            com.tibco.n2.brm.services.InvalidVersionFault,
                                                            com.tibco.n2.brm.services.InternalServiceFault,
                                                            com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault,
                                                            com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Closes a list of work items.

Specified by:

closeWorkItem in interface WorkItemManagementService

Returns:

returns an array of work item managed objects throws RuntimeException

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault

com.tibco.n2.brm.services.SecurityFault

reallocateWorkItem

public com.tibco.n2.brm.api.WorkItem[] reallocateWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds,
                                                          java.lang.String[] resources,
                                                          boolean[] revertData)
                                                   throws com.tibco.n2.brm.services.InvalidVersionFault,
                                                          com.tibco.n2.brm.services.WorkItemFault,
                                                          com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                          com.tibco.n2.brm.services.InternalServiceFault,
                                                          com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Reallocates a list of work items. For a work item it is possible to revert the work item payload to it's original state when offered.

Specified by:

reallocateWorkItem in interface WorkItemManagementService

Parameters:

workItemIds - array of work item objects

resources - array of resources

revertData - array indicating if data should be reverted to it's original state

Returns:

returns a List of work item objects

Throws:

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.SecurityFault

reallocateWorkItemData

public com.tibco.n2.brm.api.WorkItem[] reallocateWorkItemData(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds,
                                                              java.lang.String[] resources,
                                                              com.tibco.n2.brm.api.WorkItemBody[] workItemPayload)
                                                       throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                              com.tibco.n2.brm.services.WorkItemFault,
                                                              com.tibco.n2.brm.services.InvalidVersionFault,
                                                              com.tibco.n2.brm.services.InternalServiceFault,
                                                              com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Reallocates a list of work items data.

Specified by:

reallocateWorkItemData in interface WorkItemManagementService

Parameters:

workItemIds - array of work item objects

resources - array of resources

Returns:

returns a List of work item objects

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.SecurityFault

getOfferSet

public java.lang.String[] getOfferSet(com.tibco.n2.brm.api.ManagedObjectID workItemId)
                               throws com.tibco.n2.brm.services.InvalidVersionFault,
                                      com.tibco.n2.brm.services.InvalidWorkItemFault,
                                      com.tibco.n2.brm.services.InternalServiceFault

Description copied from interface: WorkItemManagementService

Returns s list of resource guids for which the work item was originally offered.

Specified by:

getOfferSet in interface WorkItemManagementService

Parameters:

workItemId - the work item id and version

Returns:

returns an array of resource guids throws RuntimeException

Throws:

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.InternalServiceFault

unallocateWorkItem

public com.tibco.n2.brm.api.WorkItem[] unallocateWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds)
                                                   throws com.tibco.n2.brm.services.InvalidEntityFault,
                                                          com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                          com.tibco.n2.brm.services.InvalidVersionFault,
                                                          com.tibco.n2.brm.services.InternalServiceFault,
                                                          com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Unallocates a list of work items. Work item must be in an allocated state before it can be unallocated.

Specified by:

unallocateWorkItem in interface WorkItemManagementService

Parameters:

workItemIds - an array of managed work item objects

Returns:

returns array of work item objects

Throws:

com.tibco.n2.brm.services.InvalidEntityFault

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.SecurityFault

allocateWorkItem

public com.tibco.n2.brm.api.WorkItem[] allocateWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds,
                                                        java.lang.String[] resources)
                                                 throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                        com.tibco.n2.brm.services.InvalidEntityFault,
                                                        com.tibco.n2.brm.services.InvalidVersionFault,
                                                        com.tibco.n2.brm.services.InternalServiceFault,
                                                        com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Allocates a list of work items

Specified by:

allocateWorkItem in interface WorkItemManagementService

Parameters:

workItemIds - array of work item objects

resources - array of resources

Returns:

returns an array of work item objects

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.InvalidEntityFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.SecurityFault

getWorkItemHeader

public com.tibco.n2.brm.api.WorkItemHeader[] getWorkItemHeader(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds)
                                                        throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                               com.tibco.n2.brm.services.InvalidVersionFault,
                                                               com.tibco.n2.brm.services.InternalServiceFault

Description copied from interface: WorkItemManagementService

Gets a list of work item headers for the supplied list of work item objects.

Specified by:

getWorkItemHeader in interface WorkItemManagementService

Parameters:

workItemIds - array of managed work item objects

Returns:

returns an array of work item header objects

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

skipWorkItem

public boolean skipWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds)
                     throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                            com.tibco.n2.brm.services.WorkItemFault,
                            com.tibco.n2.brm.services.InvalidVersionFault,
                            com.tibco.n2.brm.services.InternalServiceFault,
                            com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Skips the supplied list of managed work item objects.

Specified by:

skipWorkItem in interface WorkItemManagementService

Returns:

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.SecurityFault

setWorkItemPriority

public com.tibco.n2.brm.api.ManagedObjectID[] setWorkItemPriority(com.tibco.n2.brm.api.SetWorkItemPriority.WorkItemIDandPriority[] workItemIDsandPrioritiesArray)
                                                           throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                                  com.tibco.n2.brm.services.WorkItemFault,
                                                                  com.tibco.n2.brm.services.InvalidVersionFault,
                                                                  com.tibco.n2.brm.services.InternalServiceFault,
                                                                  com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Closes a list of work items.

Specified by:

setWorkItemPriority in interface WorkItemManagementService

Returns:

returns an array of work item managed objects throws RuntimeException

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.SecurityFault

allocateAndOpenWorkItem

public com.tibco.n2.brm.api.WorkItem[] allocateAndOpenWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds,
                                                               java.lang.String[] resources)
                                                        throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                               com.tibco.n2.brm.services.WorkItemFault,
                                                               com.tibco.n2.brm.services.InvalidEntityFault,
                                                               com.tibco.n2.brm.services.InvalidVersionFault,
                                                               com.tibco.n2.brm.services.InternalServiceFault,
                                                               com.tibco.n2.brm.services.OpenWorkItemLimitFault,
                                                               com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault,
                                                               com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Allocates and opens a list of work items

Specified by:

allocateAndOpenWorkItem in interface WorkItemManagementService

Parameters:

workItemIds - array of work item objects

resources - array of resources

Returns:

returns an array of work item objects

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidEntityFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.OpenWorkItemLimitFault

com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault

com.tibco.n2.brm.services.SecurityFault

allocateAndOpenNextWorkItem

public com.tibco.n2.brm.api.WorkItem allocateAndOpenNextWorkItem(java.lang.String resourceId)
                                                          throws com.tibco.n2.brm.services.NoMoreWorkItemsFault,
                                                                 com.tibco.n2.brm.services.WorkItemFault,
                                                                 com.tibco.n2.brm.services.InvalidEntityFault,
                                                                 com.tibco.n2.brm.services.InternalServiceFault,
                                                                 com.tibco.n2.brm.services.OpenWorkItemLimitFault,
                                                                 com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault,
                                                                 com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Allocates and opens the next work item

Specified by:

allocateAndOpenNextWorkItem in interface WorkItemManagementService

Parameters:

resourceId - resource id

Returns:

returns a work item object

Throws:

com.tibco.n2.brm.services.NoMoreWorkItemsFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidEntityFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.OpenWorkItemLimitFault

com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault

com.tibco.n2.brm.services.SecurityFault

completeWorkItem

public com.tibco.n2.brm.api.CompleteWorkItemResponseDocument.CompleteWorkItemResponse completeWorkItem(com.tibco.n2.brm.api.ManagedObjectID workItemId,
                                                                                                       com.tibco.n2.brm.api.WorkItemBody workItemPayload,
                                                                                                       boolean getNextPiledItem)
                                                                                                throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                                                                       com.tibco.n2.brm.services.WorkItemFault,
                                                                                                       com.tibco.n2.brm.services.InvalidVersionFault,
                                                                                                       com.tibco.n2.brm.services.InternalServiceFault,
                                                                                                       com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault,
                                                                                                       com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Allocates and opens the next work item

Specified by:

completeWorkItem in interface WorkItemManagementService

Returns:

returns a complete work item response object

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault

com.tibco.n2.brm.services.SecurityFault

openWorkItem

public com.tibco.n2.brm.api.WorkItemBody[] openWorkItem(com.tibco.n2.brm.api.ManagedObjectID[] workItemIds)
                                                 throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                        com.tibco.n2.brm.services.WorkItemFault,
                                                        com.tibco.n2.brm.services.InvalidVersionFault,
                                                        com.tibco.n2.brm.services.InternalServiceFault,
                                                        com.tibco.n2.brm.services.OpenWorkItemLimitFault,
                                                        com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault,
                                                        com.tibco.n2.brm.services.SecurityFault

Description copied from interface: WorkItemManagementService

Opens a work item

Specified by:

openWorkItem in interface WorkItemManagementService

Parameters:

workItemIds - array of managed work item objects

Returns:

returns an array of work item body objects

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.OpenWorkItemLimitFault

com.tibco.n2.brm.services.WorkItemAPIScriptCancelFault

com.tibco.n2.brm.services.SecurityFault

saveOpenWorkItem

public com.tibco.n2.brm.api.ManagedObjectID saveOpenWorkItem(com.tibco.n2.brm.api.ManagedObjectID workItemId,
                                                             com.tibco.n2.brm.api.WorkItemBody payload)
                                                      throws com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                             com.tibco.n2.brm.services.WorkItemFault,
                                                             com.tibco.n2.brm.services.InternalServiceFault,
                                                             com.tibco.n2.brm.services.InvalidVersionFault

Description copied from interface: WorkItemManagementService

Saves an open work item

Specified by:

saveOpenWorkItem in interface WorkItemManagementService

Parameters:

workItemId - work item id

Returns:

returns a work item body object

Throws:

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.WorkItemFault

com.tibco.n2.brm.services.InternalServiceFault

com.tibco.n2.brm.services.InvalidVersionFault

getOfferSetV2

public com.tibco.n2.common.organisation.api.XmlModelEntityId[] getOfferSetV2(com.tibco.n2.brm.api.ManagedObjectID workItemId,
                                                                             int apiVersion)
                                                                      throws com.tibco.n2.brm.services.InvalidVersionFault,
                                                                             com.tibco.n2.brm.services.InvalidWorkItemFault,
                                                                             com.tibco.n2.brm.services.InternalServiceFault

Description copied from interface: WorkItemManagementService

Returns an array of resource Model Entity IDs for which the work item was originally offered.

Specified by:

getOfferSetV2 in interface WorkItemManagementService

Parameters:

workItemId - the work item id and version

Returns:

returns an array of resource Model Entity IDs (these have type and version information along with the GUIDs). throws RuntimeException

Throws:

com.tibco.n2.brm.services.InvalidVersionFault

com.tibco.n2.brm.services.InvalidWorkItemFault

com.tibco.n2.brm.services.InternalServiceFault