|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkBasketManagerService
WorkBasketManagerService defines the work basket methods that can be called by a local or remote client.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
WBID |
createWorkBasket(WorkBasketDefinition workBasketDefinition)
Creates a work basket from the specified work basket definition. |
void |
deleteWorkBasket(java.lang.String identifier)
Deletes the specified work basket using a string representation of the work basket ID or the work basket name. |
void |
deleteWorkBasket(WBID wbid)
Deletes the specified work basket using the work basket ID. |
java.util.List |
distributeTasksToWorkBasket(java.lang.String[] tkiids,
java.lang.String identifier)
Distributes the specified task instances to the specified work basket using string representations of the task instance and work basket IDs. |
java.util.List |
distributeTasksToWorkBasket(TKIID[] tkiids,
WBID wbid)
Distributes the specified task instances to the specified work basket using task instance and work basket IDs. |
WorkItem[] |
getAllWorkItemsForWorkBasket(java.lang.String identifier)
Returns all work item assignments associated to the specified work basket using a string representation of the work basket ID or the work basket name. |
WorkItem[] |
getAllWorkItemsForWorkBasket(WBID wbid)
Returns all work item assignments associated to the specified work basket using the work basket ID. |
boolean[][] |
getAvailableActionFlagsForWorkBaskets(java.lang.String[] identifiers)
Returns the actions that can be called for the specified work baskets by the logged-on user using string representations of the work basket IDs or the work basket names. |
boolean[][] |
getAvailableActionFlagsForWorkBaskets(WBID[] wbids)
Returns the actions that can be called for the specified work baskets by the logged-on user using work basket IDs. |
int[] |
getAvailableActionsForWorkBasket(java.lang.String identifier)
Returns the actions that can be called by the logged-on user for the specified work basket using a string representation of the work basket ID or the work basket name. |
int[] |
getAvailableActionsForWorkBasket(WBID wbid)
Returns the actions that can be called by the logged-on user for the specified work basket using the work basket ID. |
java.util.List |
getDistributionTargets(java.lang.String identifier)
Retrieves the distribution targets of the specified work basket using a string representation of the work basket ID or the work basket name. |
java.util.List |
getDistributionTargets(WBID wbid)
Retrieves the distribution targets of the specified work basket using the work basket ID. |
WorkBasket |
getWorkBasket(java.lang.String identifier)
Retrieves the specified work basket using a string representation of the work basket ID or the work basket name. |
WorkBasket |
getWorkBasket(WBID wbid)
Retrieves the specified work basket using the work basket ID. |
WorkBasketDefinition |
getWorkBasketDefinition(java.lang.String identifier)
Retrieves the definition of the specified work basket using a string representation of the work basket ID or the work basket name. |
WorkBasketDefinition |
getWorkBasketDefinition(WBID wbid)
Retrieves the definition of the specified work basket using the work basket ID. |
WorkItem[] |
getWorkItemsForWorkBasket(java.lang.String identifier)
Returns the work item assignments for the logged-on user and the specified work basket using a string representation of the work basket ID or the work basket name. |
WorkItem[] |
getWorkItemsForWorkBasket(WBID wbid)
Returns the work item assignments for the logged-on user and the specified work basket using the work basket ID. |
boolean |
isWorkBasketSystemAdministrator()
States whether the logged-on user is a system administrator for work baskets. |
java.util.List |
removeAsDistributionTarget(java.lang.String identifier)
Removes the specified work basket as a distribution target from all referencing work baskets using a string representation of the work basket ID or the work basket name. |
java.util.List |
removeAsDistributionTarget(WBID wbid)
Removes the specified work basket as a distribution target from all referencing work baskets The caller must be the work basket system administrator. |
java.util.List |
transferTasksToWorkBasket(java.lang.String[] tkiids,
java.lang.String identifier,
boolean cancelClaimIfNeeded)
Transfers the specified task instances to the specified work basket using string representations of the task instance and work basket IDs or the work basket name. |
java.util.List |
transferTasksToWorkBasket(TKIID[] tkiids,
WBID wbid,
boolean cancelClaimIfNeeded)
Transfers the specified task instances to the specified work basket using task instance and work basket IDs. |
void |
updateWorkBasket(WorkBasketDefinition workBasketDefinition)
Updates a work basket with values from the specified work basket definition. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
WBID createWorkBasket(WorkBasketDefinition workBasketDefinition) throws ArchiveUnsupportedOperationException, CannotCreateWorkItemException, InvalidAssignmentReasonException, InvalidLengthException, InvalidPropertyValueException, NotAuthorizedException, ParameterNullException, WorkBasketAlreadyExistsException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must be a work basket system administrator.
The action associated to this method is WorkBasketActions.CREATEWORKBASKET
.
This method is not supported in archive mode.
workBasketDefinition
- The WorkBasketDefinition
from which a work basket is to be created.
ArchiveUnsupportedOperationException
CannotCreateWorkItemException
InvalidAssignmentReasonException
InvalidLengthException
InvalidPropertyValueException
NotAuthorizedException
ParameterNullException
WorkBasketAlreadyExistsException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
void deleteWorkBasket(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, IsDistributionTargetException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEmptyException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The work basket must not contain any task instances and must not be used as distribution target by other work baskets.
The caller must be the work basket system administrator.
The action associated to this method is WorkBasketActions.DELETEWORKBASKET
.
identifier
- A string representation of the work basket ID or the work basket name
that is used to identify the work basket.
IdWrongFormatException
IdWrongTypeException
IsDistributionTargetException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEmptyException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
void deleteWorkBasket(WBID wbid) throws IdWrongFormatException, IsDistributionTargetException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEmptyException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The work basket must not contain any task instances and must not be used as distribution target by other work baskets.
The caller must be the work basket system administrator.
The action associated to this method is WorkBasketActions.DELETEWORKBASKET
.
wbid
- The work basket ID that is used to identify the work basket.
IdWrongFormatException
IsDistributionTargetException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEmptyException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
java.util.List distributeTasksToWorkBasket(java.lang.String[] tkiids, java.lang.String identifier) throws ArchiveUnsupportedOperationException, IdWrongFormatException, IdWrongTypeException, WorkBasketDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The task instances must be in the ready state, or for invocation tasks, in the running state. Note that invocation task instances are also known as originating task instances.
The task instances' read flags are set to false. The transferredToWorkBasket flags remain unchanged.
The caller must be authorized to perform action
DISTRIBUTE
for each work basket
that contains one of the specified task instances, that is,
have distributor or transfer initiator rights on the work baskets.
The specified target work basket must be in the list of distribution targets for each work basket
that contains one of the specified task instances.
The action associated to this method is WorkBasketActions.DISTRIBUTE
.
This method is not supported in archive mode.
tkiids
- An array of string representations of task instance IDs that are used
to identify the task instances.identifier
- A string representation of the work basket ID or the work basket name. This is used
to identify the work basket.
TaskResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
ArchiveUnsupportedOperationException
IdWrongFormatException
IdWrongTypeException
WorkBasketDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
java.util.List distributeTasksToWorkBasket(TKIID[] tkiids, WBID wbid) throws ArchiveUnsupportedOperationException, IdWrongFormatException, WorkBasketDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The task instances must be in the ready state, or for invocation tasks, in the running state. Note that invocation task instances are also known as originating task instances.
The task instances' read flags are set to false. The transferredToWorkBasket flags remain unchanged.
The caller must be authorized to perform action
DISTRIBUTE
for each work basket
that contains one of the specified task instances, that is,
have distributor or transfer initiator rights on the work baskets.
The specified target work basket must be in the list of distribution targets for each work basket
that contains one of the specified task instances.
The action associated to this method is WorkBasketActions.DISTRIBUTE
.
This method is not supported in archive mode.
tkiids
- An array of task instance IDs.wbid
- The work basket ID.
TaskResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
ArchiveUnsupportedOperationException
IdWrongFormatException
WorkBasketDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
WorkItem[] getAllWorkItemsForWorkBasket(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must have a work item for the specified work basket or be a work basket system administrator.
The action associated to this method is WorkBasketActions.GETROLEINFO
.
identifier
- The string representation of a work basket ID or the work basket name that is
used to identify the work basket.
WorkItem
to view the work item properties.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkItem[] getAllWorkItemsForWorkBasket(WBID wbid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, WorkItemManagerException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must have a work item for the specified work basket or be a work basket system administrator.
The action associated to this method is WorkBasketActions.GETROLEINFO
.
wbid
- The object ID of the work basket thatis used to identify
the work basket.
WorkItem
to view the work item properties.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
boolean[][] getAvailableActionFlagsForWorkBaskets(java.lang.String[] identifiers) throws IdWrongFormatException, IdWrongTypeException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
WorkBasketActions
for possible actions.
identifiers
- An array of string representations of work basket IDs or work basket names.
The work baskets appear in the same order as specified.
Refer to WorkBasketActionIndex
for index constants that can
be used to access the columns of the two-dimensional array.
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
boolean[][] getAvailableActionFlagsForWorkBaskets(WBID[] wbids) throws IdWrongFormatException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
WorkBasketActions
for possible actions.
wbids
- An array of work basket IDs.
The work baskets appear in the same order as specified.
Refer to WorkBasketActionIndex
for index constants that can
be used to access the columns of the two-dimensional array.
IdWrongFormatException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
int[] getAvailableActionsForWorkBasket(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
WorkBasketActions
for possible actions.
identifier
- The string representation of the work basket ID or the work basket name.
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
int[] getAvailableActionsForWorkBasket(WBID wbid) throws IdWrongFormatException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
WorkBasketActions
for possible actions.
wbid
- The object ID of the work basket.
IdWrongFormatException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
java.util.List getDistributionTargets(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must have distributor or transfer initiator rights on the specified work basket.
The action associated to this method is WorkBasketActions.GETDISTRIBUTIONTARGETS
.
identifier
- A string representation of the work basket ID or the work basket name. This is used
to identify the work basket.
WorkBasket
objects that can be used as distribution targets.
Note that all possible distribution targets are returned whether they can be
used as distribution target
by the logged-on user or not.
The list is empty if there are no distribution targets for the specified work basket.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
java.util.List getDistributionTargets(WBID wbid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must have distributor or transfer initiator rights on the specified work basket.
The action associated to this method is WorkBasketActions.GETDISTRIBUTIONTARGETS
.
wbid
- The object ID of the work basket that is used to identify the work basket.
WorkBasket
objects that can be used as distribution targets.
Note that all possible distribution targets are returned whether they can be
used as distribution target
by the logged-on user or not.
The list is empty if there are no distribution targets for the specified work basket.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkBasket getWorkBasket(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must have at least reader authority for the work basket.
The action associated to this method is WorkBasketActions.GETWORKBASKET
.
identifier
- A string representation of the work basket ID or the work basket name. This is used
to identify the work basket to be retrieved.
WorkBasket
to view the properties.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkBasket getWorkBasket(WBID wbid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must have at least reader authority for the work basket.
The action associated to this method is WorkBasketActions.GETWORKBASKET
.
wbid
- The object ID of the work basket to be retrieved.
WorkBasket
to view the properties.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkBasketDefinition getWorkBasketDefinition(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must be the work basket system administrator.
The action associated to this method is WorkBasketActions.GETWORKBASKETDEFINITION
.
identifier
- A string representation of the work basket ID or the work basket name. This is used
to identify the work basket.
WorkBasketDefinition
to view the properties.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkBasketDefinition getWorkBasketDefinition(WBID wbid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must be the work basket system administrator.
The action associated to this method is WorkBasketActions.GETWORKBASKETDEFINITION
.
wbid
- The object ID of the work basket.
WorkBasketDefinition
to view the properties.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkItem[] getWorkItemsForWorkBasket(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, WorkItemManagerException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
Note that a work basket system administrator is treated like any other user, that is, does only see the personally owned work items.
The action associated to this method is WorkBasketActions.GETROLEINFO
.
identifier
- The string representation of a work basket ID or the work basket name. The string is
used to identify the work basket.
WorkItem
to view the work item properties.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
WorkItem[] getWorkItemsForWorkBasket(WBID wbid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkBasketNotEnabledException, WorkItemManagerException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
Note that a work basket system administrator is treated like any other user, that is, does only see the personally owned work items.
The action associated to this method is WorkBasketActions.GETROLEINFO
.
wbid
- The object ID of the work basket that is used to identify the work basket.
WorkItem
to view the work item properties.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkBasketNotEnabledException
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
java.util.List removeAsDistributionTarget(java.lang.String identifier) throws ArchiveUnsupportedOperationException, IdWrongFormatException, IdWrongTypeException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must be the work basket system administrator.
The action associated to this method is WorkBasketActions.UPDATE
.
This method is not supported in archive mode.
identifier
- A string representation of the work basket ID or the work basket name
that is used to identify the work basket to be removed as distribution target.
WorkBasketResult
.
The WorkBasketResult object states the object ID and name of the formerly referencing work basket. The TaskException property is not set, that is, is null. Returns an empty list when there is no work basket that referenced the specified one.
ArchiveUnsupportedOperationException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
java.util.List removeAsDistributionTarget(WBID wbid) throws ArchiveUnsupportedOperationException, IdWrongFormatException, ObjectDoesNotExistException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must be the work basket system administrator.
The action associated to this method is WorkBasketActions.UPDATE
.
This method is not supported in archive mode.
wbid
- The work basket ID
that is used to identify the work basket to be removed as distribution target.
WorkBasketResult
.
The WorkBasketResult object states the object ID and name of the formerly referencing work basket. The TaskException property is not set, that is, is null. Returns an empty list when there is no work basket that referenced the specified one.
ArchiveUnsupportedOperationException
IdWrongFormatException
ObjectDoesNotExistException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
java.util.List transferTasksToWorkBasket(java.lang.String[] tkiids, java.lang.String identifier, boolean cancelClaimIfNeeded) throws ArchiveUnsupportedOperationException, IdWrongFormatException, IdWrongTypeException, WorkBasketDoesNotExistException, WorkBasketNotAuthorizedException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The task instances must be in the ready state, or for invocation tasks, in the running state. Note that invocation task instances are also known as originating task instances.
The task instances' read flags are set to false and the transferredToWorkBasket flags to true.
The caller must be authorized to perform action
TRANSFERFROMWORKBASKET
for each work basket
that contains one of the specified task instances and
TRANSFERTOWORKBASKET
for the specified target work basket.
That is, the caller must have transfer initiator rights for the source work baskets and
appender rights for the target work basket.
The action associated to this method is WorkBasketActions.TRANSFERFROMWORKBASKET
and WorkBasketActions.TRANSFERTOWORKBASKET
.
This method is not supported in archive mode.
tkiids
- An array of string representations of task instance IDs that are used
to identify the task instances.identifier
- A string representation of the work basket ID or the work basket name. This is used
to identify the work basket.cancelClaimIfNeeded
- Specifies whether claiming of tasks should be cancelled.
True states that the claim of a task should be cancelled,
False states that the claim of a task should be kept, that is, transfer is prohibited.
TaskResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
ArchiveUnsupportedOperationException
IdWrongFormatException
IdWrongTypeException
WorkBasketDoesNotExistException
WorkBasketNotAuthorizedException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
java.util.List transferTasksToWorkBasket(TKIID[] tkiids, WBID wbid, boolean cancelClaimIfNeeded) throws ArchiveUnsupportedOperationException, IdWrongFormatException, WorkBasketDoesNotExistException, WorkBasketNotAuthorizedException, WorkBasketNotEnabledException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The task instances must be in the ready state, or for invocation tasks, in the running state. Note that invocation task instances are also known as originating task instances.
The task instances' read flags are set to false and the transferredToWorkBasket flags to true.
The caller must be authorized to perform action
TRANSFERFROMWORKBASKET
for each work basket
that contains one of the specified task instances and
TRANSFERTOWORKBASKET
for the specified target work basket.
That is, the caller must have transfer initiator rights for the source work baskets and
appender rights for the target work basket.
The action associated to this method is WorkBasketActions.TRANSFERFROMWORKBASKET
and WorkBasketActions.TRANSFERTOWORKBASKET
.
This method is not supported in archive mode.
tkiids
- An array of task instance IDs.wbid
- The work basket ID.cancelClaimIfNeeded
- Specifies whether claiming of tasks should be cancelled.
True states that the claim of a task should be cancelled,
False states that the claim of a task should be kept, that is, transfer is prohibited.
TaskResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
ArchiveUnsupportedOperationException
IdWrongFormatException
WorkBasketDoesNotExistException
WorkBasketNotAuthorizedException
WorkBasketNotEnabledException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
void updateWorkBasket(WorkBasketDefinition workBasketDefinition) throws ArchiveUnsupportedOperationException, CannotCreateWorkItemException, InvalidAssignmentReasonException, InvalidLengthException, InvalidPropertyValueException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WorkBasketNotEnabledException, WorkItemManagerException, UnexpectedFailureException, java.rmi.RemoteException, javax.ejb.EJBException
The caller must be a work basket system administrator.
The action associated to this method is WorkBasketActions.UPDATE
.
This method is not supported in archive mode.
workBasketDefinition
- The WorkBasketDefinition
from which a work basket is to be updated.
ArchiveUnsupportedOperationException
CannotCreateWorkItemException
InvalidAssignmentReasonException
InvalidLengthException
InvalidPropertyValueException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WorkBasketNotEnabledException
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Change History
Release | Modification |
---|---|
7.0.0.3 | Throws an ArchiveUnsupportedOperationException when called in archive mode. |
boolean isWorkBasketSystemAdministrator() throws java.rmi.RemoteException, javax.ejb.EJBException
In general, authorization is granted to persons explicitly when a work basket is created or updated. Above that, special authority is granted to a person playing the role of a work basket system administrator. A work basket system administrator has all priviledges for work baskets.
java.rmi.RemoteException
javax.ejb.EJBException
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |