|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWRoleDefinition
public class VWRoleDefinition
Use this class to create, read, delete, or modify role definition properties.
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call |
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)
Appends an XML string representing this instance to the buffer specified. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public int getRevision() throws VWException
VWException
public java.lang.String getName() throws VWException
VWException
public java.lang.String getAuthoredName() throws VWException
VWException
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the name of the role definition.
VWException
public java.lang.String getDescription() throws VWException
VWException
public void setDescription(java.lang.String description) throws VWException
description
- A String containing the description of the role definition.
VWException
public java.lang.String getHomePageURL() throws VWException
VWException
public void setHomePageURL(java.lang.String homePageURL) throws VWException
homePageURL
- A String containing the URL of the home page for the role definition.
VWException
public VWParticipant[] fetchRoleParticipants() throws VWException
VWException
public boolean hasRoleParticipantsChanged() throws VWException
VWException
public void setRoleParticipants(VWParticipant[] members) throws VWException
members
- An array of VWParticipant objects identifying the users and/or groups who are to be
members of this role definition.
VWException
public java.lang.String[] getRoleParticipantNames() throws VWException
VWException
public VWWorkBasketDefinition[] getWorkBasketDefinitions() throws VWException
VWException
public void setWorkBasketDefinitions(VWWorkBasketDefinition[] workBasketDefs) throws VWException
workBasketDefs
- An array of VWWorkBasketDefinition objects identifying the workbaskets that are
to be defined for this role definition.
VWException
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttributeInfo object containing the string and value pairs representing the
attributes for the role definition.
VWException
getAttributeInfo()
public int getObjId() throws VWException
VWException
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public java.lang.Object clone()
clone
in class java.lang.Object
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |