Process API

filenet.vw.api
Class VWRole

java.lang.Object
  extended by filenet.vw.api.VWRole
All Implemented Interfaces:
java.io.Serializable

public 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
static class VWRole.WorkBasketReference
          Use this class to retrieve information about a workbasket associated with a role.
 
Method Summary
 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.
 int getRevision()
          Gets the revision number for the role.
 VWRole.WorkBasketReference[] getWorkBasketReferences()
          Gets all of the workbaskets associated with this role.
 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
 

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:
workBasketNname - A String containing the name of the work basket 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.

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.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.