VWRole.WorkBasketReference (Process API Documentation)

Skip navigation links

Process API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- filenet.vw.api.VWRole.WorkBasketReference

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

VWRole
```
public static final class VWRole.WorkBasketReference
extends java.lang.Object
implements java.io.Serializable
```
Use this class to retrieve information about a workbasket associated with a role.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getQueueName()` Gets the translated name of the queue associated with the workbasket for this role.
`java.lang.String`	`getWorkBasketAuthoredName()` Gets the name originally assigned to the workbasket associated with this role.
`java.lang.String`	`getWorkBasketName()` Gets the translated name of the workbasket associated with this role.
`java.lang.String`	`toString()` Gets a String version of the workbasket description.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getQueueName
```
public java.lang.String getQueueName()
```
    Gets the translated name of the queue associated with the workbasket for this role.
    
    Returns:
    
    A String containing the translated name of the queue.
  - getWorkBasketName
```
public java.lang.String getWorkBasketName()
                                   throws VWException
```
    Gets the translated name of the workbasket associated with this role.
    
    Returns:
    
    A String containing the authored name of the workbasket.
    
    Throws:
    
    VWException
  - getWorkBasketAuthoredName
```
public java.lang.String getWorkBasketAuthoredName()
```
    Gets the name originally assigned to the workbasket associated with this role.
    
    Returns:
    
    A String containing the original name of the workbasket.
  - toString
```
public java.lang.String toString()
```
    Gets a String version of the workbasket description.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the description of the workbasket.