VWRole (Process API Documentation)

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

All Implemented Interfaces:

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

Since:

P8 4.5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VWRole.WorkBasketReference
Use this class to retrieve information about a workbasket associated with a role.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VWRole.WorkBasketReference` Use this class to retrieve information about a workbasket associated with a role.

Constructor Summary

Constructors
Constructor and Description
`VWRole(VWSession theSession, java.lang.String roleName, java.lang.String applicationSpaceName)` Creates a VWRole instance for the specified application space and session context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VWWorkBasket`	`fetchWorkBasket(java.lang.String queueName, java.lang.String workBasketName)` Retrieves the specified work basket for this role.
`VWWorkBasket[]`	`fetchWorkBaskets()` Retrieves the VWWorkBaskets that this role references.
`java.lang.String`	`getApplicationSpaceName()` Gets the name of the application space in which this role is defined.
`VWAttributeInfo`	`getAttributeInfo()` Gets the role attributes as paired labels (hashtable keys) and values in String format.
`java.lang.String`	`getAuthoredName()` Gets the original role name.
`java.lang.String`	`getDescription()` Gets the role description.
`java.lang.String`	`getHomePageURL()` Gets the URL of the home page for the role.
`int`	`getId()` Gets the object ID of the role.
`java.lang.String`	`getName()` Gets the current name for the role.
`VWParticipant[]`	`getParticipants()` Gets the participants for this local role object.
`int`	`getRevision()` Gets the revision number for the role.
`VWRole.WorkBasketReference[]`	`getWorkBasketReferences()` Gets all of the workbaskets associated with this role.
`VWParticipant[]`	`refreshParticipants()` Retrieves from the Process Engine server the current participant names specified in this role object.
`VWParticipant[]`	`saveParticipants(java.lang.String[] removeParticipantNames, java.lang.String[] addParticipantNames)` Saves to the Process Engine server the current participant names specified in this role object.
`java.lang.String`	`toString()` Gets a String version of the description for the role.

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

- Constructor Detail
  - VWRole
```
public VWRole(VWSession theSession,
              java.lang.String roleName,
              java.lang.String applicationSpaceName)
```
    Creates a VWRole instance for the specified application space and session context. This constructor enables you to call the VWRole.saveParticipants(String[], String[]) method without first requiring an RPC to the Process Engine server to retrieve this object.
    
    Parameters:
    
    theSession - A VWSession object for the session to use.
    
    roleName - A String containing the name of the role to create.
    
    applicationSpaceName - A String containing the name of the application space with which this role is associated.
    
    Since:
    
    PE 4.6.0
- Method Detail
  - getRevision
```
public int getRevision()
```
    Gets the revision number for the role.
    
    Returns:
    
    An int indicating the revision.
  - getName
```
public java.lang.String getName()
```
    Gets the current name for the role.
    
    Returns:
    
    A String containing the current name of the role.
  - getAuthoredName
```
public java.lang.String getAuthoredName()
```
    Gets the original role name.
    
    Returns:
    
    A String containing the name originally assigned to the role.
  - getId
```
public int getId()
```
    Gets the object ID of the role.
    
    Returns:
    
    An integer representing the object ID of the role.
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the role description.
    
    Returns:
    
    A String containing any entered description of the role.
  - getHomePageURL
```
public java.lang.String getHomePageURL()
```
    Gets the URL of the home page for the role.
    
    Returns:
    
    A String containing the relative URL for the role.
  - getApplicationSpaceName
```
public java.lang.String getApplicationSpaceName()
```
    Gets the name of the application space in which this role is defined.
    
    Returns:
    
    A String containing the name of the application space.
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
```
    Gets the role attributes as paired labels (hashtable keys) and values in String format.
    
    Returns:
    
    A VWAttributeInfo object containing a hashtable of key (label) and value String pairs representing the attributes for the role.
  - fetchWorkBasket
```
public VWWorkBasket fetchWorkBasket(java.lang.String queueName,
                                    java.lang.String workBasketName)
                             throws VWException
```
    Retrieves the specified work basket for this role.
    
    Parameters:
    
    queueName - A String containing the queue of the workbasket.
    
    workBasketName - A String containing the name of a workbasket to retrieve.
    
    Returns:
    
    A VWWorkBasket object identifying the work basket, or null if the specified work basket is not found.
    
    Throws:
    
    VWException
  - fetchWorkBaskets
```
public VWWorkBasket[] fetchWorkBaskets()
                                throws VWException
```
    Retrieves the VWWorkBaskets that this role references.
    
    Returns:
    
    An array of WorkBasket objects identifying the work baskets.
    
    Throws:
    
    VWException
  - getWorkBasketReferences
```
public VWRole.WorkBasketReference[] getWorkBasketReferences()
```
    Gets all of the workbaskets associated with this role.
    
    Returns:
    
    An array of WorkBasketReference objects identifying the workbaskets associated with this role.
  - getParticipants
```
public VWParticipant[] getParticipants()
                                throws VWException
```
    Gets the participants for this local role object.
    If the role object is fetched using the VWSession.fetchRole(String, String) method, or participant information is populated using the VWRole.refreshParticipants() method, the current user must have Write permission on the application space to see the participant information.
    
    Returns:
    
    An array of VWParticipant objects representing the participants in this role.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.6.0
  - refreshParticipants
```
public VWParticipant[] refreshParticipants()
                                    throws VWException
```
    Retrieves from the Process Engine server the current participant names specified in this role object. The current user must have Write permission on the application space to retrieve the participants for the role.
    
    Returns:
    
    An array of VWParticipant objects that represent the participants for the role.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.6.0
    
    See Also:
    
    VWRole.saveParticipants(java.lang.String[], java.lang.String[]), VWStepDefinition.getParticipants()
  - saveParticipants
```
public VWParticipant[] saveParticipants(java.lang.String[] removeParticipantNames,
                                        java.lang.String[] addParticipantNames)
                                 throws VWException
```
    Saves to the Process Engine server the current participant names specified in this role object. The current user must have Write permission on the application space to update the participants for the role.
    
    Parameters:
    
    removeParticipantNames - A String array of participant names to be removed from the role.
    
    addParticipantNames - A String array of participant names to be added to the role.
    
    Returns:
    
    An array containing the updated list of participants.
    
    Throws:
    
    VWException - Thrown for various causes.
    
    Since:
    
    PE 4.6.0
    
    See Also:
    
    VWRole.refreshParticipants(), VWStepDefinition.getParticipants()
  - toString
```
public java.lang.String toString()
```
    Gets a String version of the description for the role.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the description of the role.

Methods inherited from class java.lang.Object

VWRole

getRevision

getName

getAuthoredName

getId

getDescription

getHomePageURL

getApplicationSpaceName

getAttributeInfo

fetchWorkBasket

fetchWorkBaskets

getWorkBasketReferences

getParticipants

refreshParticipants

saveParticipants

toString