VWApplicationSpaceDefinition (Process API Documentation)

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

All Implemented Interfaces:

IVWtoXML, java.io.Serializable, java.lang.Cloneable
```
public final class VWApplicationSpaceDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, IVWtoXML
```
Use this class to create, read, delete, or modify application space properties.
An application space definition can be retrieved using VWSystemConfiguration.getApplicationSpaceDefinition(String). You can retrieve all application space definitions using VWSystemConfiguration.getApplicationSpaceDefinitions().

Since:

PE 4.5.0

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`boolean`	`hasChanged()` Returns a boolean value indicating whether or not this application space has changed.
`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)` Deprecated. Use `VWXMLConfiguration.makeXMLBlock(IVWtoXML[])`.
`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
  - getRevision
```
public int getRevision()
                throws VWException
```
    Gets the revision number for the application space.
    
    Returns:
    
    An int indicating the revision.
    
    Throws:
    
    VWException
  - getName
```
public java.lang.String getName()
```
    Gets the current application space name.
    
    Returns:
    
    A String containing the current name of the application space.
    
    Since:
    
    PE 4.5.0
  - getAuthoredName
```
public java.lang.String getAuthoredName()
                                 throws VWException
```
    Gets the original application space name.
    
    Returns:
    
    A String containing the original name of the application space.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.5.0
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the application space description.
    
    Returns:
    
    A String containing any entered description of the application space.
    
    Since:
    
    PE 4.5.0
  - setDescription
```
public void setDescription(java.lang.String description)
                    throws VWException
```
    Sets the application space description.
    
    Parameters:
    
    description - A String containing the description of the application space.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.5.0
  - getWriteSecurity
```
public java.lang.String[] getWriteSecurity()
                                    throws VWException
```
    Gets the users and/or groups who have write access to the application space.
    
    Returns:
    
    A String array of users and/or groups who have Write access to the application space.
    
    Throws:
    
    VWException
  - getWriteSecurityPx
```
public VWParticipant[] getWriteSecurityPx()
                                   throws VWException
```
    Gets the VWParticipant objects specifying the users and/or groups who have write access to the application space.
    
    Returns:
    
    An array of VWParticipant objects specifying the users and/or groups who have Write access to the application space.
    
    Throws:
    
    VWException
  - setWriteSecurityPx
```
public void setWriteSecurityPx(VWParticipant[] newWriteSecurityPx)
                        throws VWException
```
    Sets the Write access for this object.
    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 VWApplicationSpaceDefinition.setReadSecurityPx(VWParticipant[]).
    
    Parameters:
    
    newWriteSecurityPx - An array of VWParticipant objects specifying the users and groups who are to have Write access to the application space.
    
    Throws:
    
    VWException
  - getRoleDefinition
```
public VWRoleDefinition getRoleDefinition(java.lang.String roleName)
                                   throws VWException
```
    Gets the specified role definition, or null if the role cannot be found.
    
    Parameters:
    
    roleName - A String containing the name of the role.
    
    Returns:
    
    The VWRoleDefinition identified by the specified name. This will be null if the role definition is not found.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.5.0
  - getRoleDefinitions
```
public VWRoleDefinition[] getRoleDefinitions()
                                      throws VWException
```
    Gets the role definitions.
    
    Returns:
    
    An array of VWRoleDefinition objects, or null if no roles definitions are found.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.5.0
  - createRoleDefinition
```
public VWRoleDefinition createRoleDefinition(java.lang.String roleName)
                                      throws VWException
```
    Creates a new role definition.
    
    Parameters:
    
    roleName - A String containing the name to use for the role definition.
    
    Returns:
    
    The VWRoleDefinition object for the new role definition.
    
    Throws:
    
    VWException - Thrown if a role definition having the specified name already exists.
    
    Since:
    
    PE 4.5.0
  - deleteRoleDefinition
```
public VWRoleDefinition deleteRoleDefinition(java.lang.String roleName)
                                      throws VWException
```
    Deletes the specified role definition.
    
    Parameters:
    
    roleName - A String containing the name of the role definition to be deleted.
    
    Returns:
    
    A VWRoleDefinition object for the role definition deleted.
    
    Throws:
    
    VWException - Thrown if the specified role definition name is null or invalid.
    
    Since:
    
    PE 4.5.0
  - createCopyOfRoleDefinition
```
public VWRoleDefinition createCopyOfRoleDefinition(java.lang.String roleName,
                                                   VWRoleDefinition origRoleDef)
                                            throws VWException
```
    Creates a new role definition using the data from the specified role definition.
    
    Parameters:
    
    roleName - A String containing the name to use for the role definition.
    
    origRoleDef - A reference to the role definition to copy.
    
    Returns:
    
    The VWRoleDefinition object for the new role definition.
    
    Throws:
    
    VWException - Thrown if a role definition having the specified name already exists.
    
    Since:
    
    PE 4.5.0
  - updateRoleDefinition
```
public void updateRoleDefinition(VWRoleDefinition theRoleDefinition)
                          throws VWException
```
    Updates a role definition.
    
    Parameters:
    
    theRoleDefinition - The VWRoleDefinition object representing the role definition to update.
    
    Throws:
    
    VWException - Thrown if the role definition does not exist or if the system encounters an error while attempting to update the role definition.
    
    See Also:
    
    VWRoleDefinition
  - clone
```
public java.lang.Object clone()
```
    Creates a clone of this VWApplicationSpaceDefinition object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A VWApplicationSpaceDefinition object that is a clone of this instance.
    
    Since:
    
    PE 4.5.0
  - toString
```
public java.lang.String toString()
```
    Gets the String version of the application space name.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the application space name.
    
    Since:
    
    PE 4.5.0
  - getObjId
```
public int getObjId()
             throws VWException
```
    Gets the object ID of this application space definition.
    
    Returns:
    
    An int indicating the object ID.
    
    Throws:
    
    VWException
    
    Since:
    
    PE 4.5.0
  - 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
  - hasChanged
```
public boolean hasChanged()
                   throws VWException
```
    Returns a boolean value indicating whether or not this application space has changed.
    
    Returns:
    
    A value of true if this application space has changed; false otherwise.
    
    Throws:
    
    VWException - Thrown if an error occurs.
    
    Since:
    
    PE 4.5.0
  - setAttributeInfo
```
public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
```
    Sets the attributes property value for the application space.
    
    Parameters:
    
    theAttributeInfo - A VWAttributeInfo object containing the string and value pairs representing the attributes for the application space.
    
    Throws:
    
    VWException
    
    See Also:
    
    VWApplicationSpaceDefinition.getAttributeInfo()
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
                                 throws VWException
```
    Gets the 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 application space.
    
    Throws:
    
    VWException - see #setAttributeInfo
  - getReadSecurity
```
public java.lang.String[] getReadSecurity()
                                   throws VWException
```
    Deprecated.
    
    Returns:
    
    readSecurity A String array of users and/or groups having Read access to the application space.
    
    Throws:
    
    VWException
  - getReadSecurityPx
```
public VWParticipant[] getReadSecurityPx()
                                  throws VWException
```
    Deprecated.
    
    Throws:
    
    VWException
  - setReadSecurityPx
```
public void setReadSecurityPx(VWParticipant[] newReadSecurityPx)
                       throws VWException
```
    Deprecated.
    
    Throws:
    
    VWException

Methods inherited from class java.lang.Object

getRevision

getName

getAuthoredName

getDescription

setDescription

getWriteSecurity

getWriteSecurityPx

setWriteSecurityPx

getRoleDefinition

getRoleDefinitions

createRoleDefinition

deleteRoleDefinition

createCopyOfRoleDefinition

updateRoleDefinition

clone

toString

getObjId

toXML

hasChanged

setAttributeInfo

getAttributeInfo

getReadSecurity

getReadSecurityPx

setReadSecurityPx