|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWApplicationSpaceDefinition
public class VWApplicationSpaceDefinition
Use this class to create, read, delete, or modify application space properties.
An application space definition can be retrieved using VWSession.fetchSystemConfiguration()
.
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 VWApplicationSpaceDefinition object. |
VWRoleDefinition |
createCopyOfRoleDefinition(java.lang.String roleName,
VWRoleDefinition origRoleDef)
Creates a new role definition using the data from the specified role definition. |
VWRoleDefinition |
createRoleDefinition(java.lang.String roleName)
Creates a new role definition. |
VWRoleDefinition |
deleteRoleDefinition(java.lang.String roleName)
Deletes the specified role definition. |
VWAttributeInfo |
getAttributeInfo()
Gets the attributes as paired labels (hashtable keys) and values in String format. |
java.lang.String |
getAuthoredName()
Gets the original application space name. |
java.lang.String |
getDescription()
Gets the application space description. |
java.lang.String |
getName()
Gets the current application space name. |
int |
getObjId()
Gets the object ID of this application space definition. |
java.lang.String[] |
getReadSecurity()
Deprecated. |
VWParticipant[] |
getReadSecurityPx()
Deprecated. |
int |
getRevision()
Gets the revision number for the application space. |
VWRoleDefinition |
getRoleDefinition(java.lang.String roleName)
Gets the specified role definition, or null if the role cannot be found. |
VWRoleDefinition[] |
getRoleDefinitions()
Gets the role definitions. |
java.lang.String[] |
getWriteSecurity()
Gets the users and/or groups who have write access to the application space. |
VWParticipant[] |
getWriteSecurityPx()
Gets the VWParticipant objects specifying the users and/or groups who have write access to the application space. |
void |
setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the application space. |
void |
setDescription(java.lang.String description)
Sets the application space description. |
void |
setReadSecurityPx(VWParticipant[] newReadSecurityPx)
Deprecated. |
void |
setWriteSecurityPx(VWParticipant[] newWriteSecurityPx)
Sets the Write access for this object. |
java.lang.String |
toString()
Gets the String version of the application space name. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
updateRoleDefinition(VWRoleDefinition theRoleDefinition)
Updates a role definition. |
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()
public java.lang.String getAuthoredName() throws VWException
VWException
public java.lang.String getDescription()
public void setDescription(java.lang.String description) throws VWException
description
- A String containing the description of the application space.
VWException
public java.lang.String[] getWriteSecurity() throws VWException
VWException
public VWParticipant[] getWriteSecurityPx() throws VWException
VWException
public void setWriteSecurityPx(VWParticipant[] newWriteSecurityPx) throws VWException
Note: This method does not validate user and group information. However, user and group information
can be validated subsequently using VWSystemConfiguration.commit()
.
Use this method in conjunction with setReadSecurityPx(VWParticipant[])
.
newWriteSecurityPx
- An array of VWParticipant objects specifying the users and groups who are to
have Write access to the application space.
VWException
public VWRoleDefinition getRoleDefinition(java.lang.String roleName) throws VWException
roleName
- A String containing the name of the role.
VWException
public VWRoleDefinition[] getRoleDefinitions() throws VWException
VWException
public VWRoleDefinition createRoleDefinition(java.lang.String roleName) throws VWException
roleName
- A String containing the name to use for the role definition.
VWException
- Thrown if a role definition having the specified name already exists.public VWRoleDefinition deleteRoleDefinition(java.lang.String roleName) throws VWException
roleName
- A String containing the name of the role definition to be deleted.
VWException
- Thrown if the specified role definition name is null or invalid.public VWRoleDefinition createCopyOfRoleDefinition(java.lang.String roleName, VWRoleDefinition origRoleDef) throws VWException
roleName
- A String containing the name to use for the role definition.origRoleDef
- A reference to the role definition to copy.
VWException
- Thrown if a role definition having the specified name already exists.public void updateRoleDefinition(VWRoleDefinition theRoleDefinition) throws VWException
theRoleDefinition
- The VWRoleDefinition object representing the role definition to
update.
VWException
- Thrown if the role definition does not exist or if the system
encounters an error while attempting to update the role definition.VWRoleDefinition
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public int getObjId() throws VWException
VWException
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 void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttributeInfo object containing the string and value pairs representing the
attributes for the application space.
VWException
getAttributeInfo()
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
- see #setAttributeInfopublic java.lang.String[] getReadSecurity() throws VWException
VWException
public VWParticipant[] getReadSecurityPx() throws VWException
VWException
public void setReadSecurityPx(VWParticipant[] newReadSecurityPx) throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |