filenet.vw.api

Class VWApplicationSpace

java.lang.Object

filenet.vw.api.VWApplicationSpace

All Implemented Interfaces:

java.io.Serializable

public final class VWApplicationSpace
extends java.lang.Object
implements java.io.Serializable

Use this class to retrieve information about an Application Space.

Since:

PE 4.6.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
VWAttributeInfo	getAttributeInfo() Gets the application space 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.
int	getId() Gets the object ID of the application space.
java.lang.String	getName() Gets the current name for the application space.
int	getRevision() Gets the revision number for the application space.
VWRole	getRole(java.lang.String roleName) Gets the specified role for this application space object.
VWRole[]	getRoles() Gets the roles for this application space object.
java.lang.String	toString() Gets a String containing some of the application space properties.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAttributeInfo

public VWAttributeInfo getAttributeInfo()

Gets the application space 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.

Since:

PE 4.6.0

getAuthoredName

public java.lang.String getAuthoredName()

Gets the original application space name.

Returns:

A String containing the name originally assigned to the application space.

Since:

PE 4.6.0

getDescription

public java.lang.String getDescription()

Gets the application space description.

Returns:

A String containing the description of the application space, or null if no description exists.

Since:

PE 4.6.0

getId

public int getId()

Gets the object ID of the application space.

Returns:

An integer representing the object ID of the application space.

Since:

PE 4.6.0

getName

public java.lang.String getName()

Gets the current name for the application space.

Returns:

A String containing the current name of the application space.

Since:

PE 4.6.0

getRevision

public int getRevision()

Gets the revision number for the application space.

Returns:

An int indicating the revision.

Since:

PE 4.6.0

getRoles

public VWRole[] getRoles()
                  throws VWException

Gets the roles for this application space object.

Returns:

An array of VWRole objects if the application space object is fetched using the VWSession.APPLICATIONSPACE_INCLUDING_ROLES or the VWSession.APPLICATIONSPACE_INCLUDING_ROLE_MEMBERS flags; otherwise, a null value is returned.

Throws:

VWException

Since:

PE 4.6.0

getRole

public VWRole getRole(java.lang.String roleName)
               throws VWException

Gets the specified role for this application space object.

Returns:

The named VWRole object if the application space object is fetched using the VWSession.APPLICATIONSPACE_INCLUDING_ROLES or the VWSession.APPLICATIONSPACE_INCLUDING_ROLE_MEMBERS flags; otherwise, a null value is returned.

Throws:

VWException

Since:

PE 4.6.0

toString

public java.lang.String toString()

Gets a String containing some of the application space properties.

Overrides:

toString in class java.lang.Object

Returns:

A String containing some of the application space properties.

Since:

PE 4.6.0