Process Java API: VWRoleDefinition (Process API Documentation)

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

All Implemented Interfaces:

IVWtoXML, java.io.Serializable, java.lang.Cloneable
```
public final class VWRoleDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, IVWtoXML
```
Use this class to create, read, delete, or modify role definition properties.

Since:

PE 4.5.0

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a clone of this role definition.
`VWParticipant[]`	`fetchRoleParticipants()` Retrieves the members (users and/or groups) of this role definition.
`VWAttributeInfo`	`getAttributeInfo()` Gets the role definition attributes as paired labels (hashtable keys) and values in String format.
`java.lang.String`	`getAuthoredName()` Gets the original role definition name.
`java.lang.String`	`getDescription()` Gets the role definition description.
`java.lang.String`	`getHomePageURL()` Gets the URL of the home page for the role definition.
`java.lang.String`	`getName()` Gets the current role definition name.
`int`	`getObjId()` Gets the object ID of this role definition.
`int`	`getRevision()` Gets the revision number for the role definition.
`java.lang.String[]`	`getRoleParticipantNames()` Gets the members (users and/or groups) of this role definition.
`VWWorkBasketDefinition[]`	`getWorkBasketDefinitions()` Gets the workbaskets defined for this role definition.
`boolean`	`hasRoleParticipantsChanged()`
`void`	`setAttributeInfo(VWAttributeInfo theAttributeInfo)` Sets the attributes property value for the role definition.
`void`	`setDescription(java.lang.String description)` Sets the role definition description.
`void`	`setHomePageURL(java.lang.String homePageURL)` Sets the URL of the home page for the role definition.
`void`	`setName(java.lang.String theName)` Sets the role definition name.
`void`	`setRoleParticipants(VWParticipant[] members)` Sets the members (users and/or groups) of this role definition.
`void`	`setWorkBasketDefinitions(VWWorkBasketDefinition[] workBasketDefs)` Sets the workbasket definitions for this role definition.
`java.lang.String`	`toString()` Gets the String version of the role definition name.
`void`	`toXML(java.lang.StringBuffer theBuffer)` Deprecated. Use `VWXMLConfiguration.makeXMLBlock(IVWtoXML[])`.

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

- Method Detail
  - getRevision
```
public int getRevision()
                throws VWException
```
    Gets the revision number for the role definition.
    
    Returns:
    An int indicating the revision.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getName
```
public java.lang.String getName()
                         throws VWException
```
    Gets the current role definition name.
    
    Returns:
    A String containing the current name of the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getAuthoredName
```
public java.lang.String getAuthoredName()
                                 throws VWException
```
    Gets the original role definition name.
    
    Returns:
    A String containing the original name of the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - setName
```
public void setName(java.lang.String theName)
             throws VWException
```
    Sets the role definition name.
    
    Parameters:
    theName - A String containing the name of the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getDescription
```
public java.lang.String getDescription()
                                throws VWException
```
    Gets the role definition description.
    
    Returns:
    A String containing any entered description of the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - setDescription
```
public void setDescription(java.lang.String description)
                    throws VWException
```
    Sets the role definition description.
    
    Parameters:
    description - A String containing the description of the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getHomePageURL
```
public java.lang.String getHomePageURL()
                                throws VWException
```
    Gets the URL of the home page for the role definition.
    
    Returns:
    A String containing the relative URL for the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - setHomePageURL
```
public void setHomePageURL(java.lang.String homePageURL)
                    throws VWException
```
    Sets the URL of the home page for the role definition.
    
    Parameters:
    homePageURL - A String containing the URL of the home page for the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - fetchRoleParticipants
```
public VWParticipant[] fetchRoleParticipants()
                                      throws VWException
```
    Retrieves the members (users and/or groups) of this role definition.
    
    Returns:
    An array of VWParticipant objects identifying the users and/or groups who are members of this role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - hasRoleParticipantsChanged
```
public boolean hasRoleParticipantsChanged()
                                   throws VWException
```
    Returns:
    true if the set of role participants has been changed; false otherwise.
    
    Throws:
    
    VWException - Thrown for various causes.
    Since:
    
    PE 4.5.0
  - setRoleParticipants
```
public void setRoleParticipants(VWParticipant[] members)
                         throws VWException
```
    Sets the members (users and/or groups) of this role definition.
    
    Parameters:
    members - An array of VWParticipant objects identifying the users and/or groups who are to be members of this role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getRoleParticipantNames
```
public java.lang.String[] getRoleParticipantNames()
                                           throws VWException
```
    Gets the members (users and/or groups) of this role definition.
    
    Returns:
    A String array containing the role participant (user and/or group) names.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getWorkBasketDefinitions
```
public VWWorkBasketDefinition[] getWorkBasketDefinitions()
                                                  throws VWException
```
    Gets the workbaskets defined for this role definition.
    
    Returns:
    An array of VWWorkBasketDefinition objects, or null if no workbaskets are defined for this role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - setWorkBasketDefinitions
```
public void setWorkBasketDefinitions(VWWorkBasketDefinition[] workBasketDefs)
                              throws VWException
```
    Sets the workbasket definitions for this role definition.
    
    Parameters:
    workBasketDefs - An array of VWWorkBasketDefinition objects identifying the workbaskets that are to be defined for this role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
                                 throws VWException
```
    Gets the role definition 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 definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
    
    See Also:
    VWRoleDefinition.setAttributeInfo(filenet.vw.api.VWAttributeInfo)
  - setAttributeInfo
```
public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
```
    Sets the attributes property value for the role definition.
    
    Parameters:
    theAttributeInfo - A VWAttributeInfo object containing the string and value pairs representing the attributes for the role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
    
    See Also:
    VWRoleDefinition.getAttributeInfo()
  - getObjId
```
public int getObjId()
             throws VWException
```
    Gets the object ID of this role definition.
    
    Returns:
    An int indicating the object ID for this role definition.
    
    Throws:
    
    VWException
    Since:
    
    PE 4.5.0
  - toString
```
public java.lang.String toString()
```
    Gets the String version of the role definition name.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String containing the role definition name.
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).
    
    Appends an XML string representing this instance to the buffer specified.
    Warning: This XML string is nonextensible, and cannot be modified in any way.
    
    Specified by:
    
    toXML in interface IVWtoXML
    
    Parameters:
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    Since:
    
    PE 4.5.0
    
    See Also:
    VWXMLConfiguration
  - clone
```
public java.lang.Object clone()
```
    Creates a clone of this role definition.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    A VWRoleDefinition object that is a clone of this instance.
    Since:
    
    PE 4.5.0

Methods inherited from class java.lang.Object

getRevision

getName

getAuthoredName

setName

getDescription

setDescription

getHomePageURL

setHomePageURL

fetchRoleParticipants

hasRoleParticipantsChanged

setRoleParticipants

getRoleParticipantNames

getWorkBasketDefinitions

setWorkBasketDefinitions

getAttributeInfo

setAttributeInfo

getObjId

toString

toXML

clone