Process Class Relationships

filenet.vw.api
Class VWRosterDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWTableDefinition
        |
        +--filenet.vw.api.VWRosterDefinition
All Implemented Interfaces:
java.lang.Cloneable, IVWTableDefinition, java.io.Serializable

public final class VWRosterDefinition
extends filenet.vw.api.VWTableDefinition
implements java.io.Serializable, IVWTableDefinition, java.lang.Cloneable

Use the VWRosterDefinition class to retrieve and administer roster definition information. The methods of this class operate in conjunction with VWSystemConfiguration class methods as follows:

Since:
VWWS3.10
See Also:
VWSystemConfiguration, Serialized Form

Field Summary
static int CONFIG_TYPE_LOG
          Value of 3. This constant indicates a log configuration type.
static int CONFIG_TYPE_QUEUE
          Value of 2. This constant indicates a queue configuration type.
static int CONFIG_TYPE_ROSTER
          Value of 1. This constant indicates a roster configuration type.
static int LVALUE
          Value of 0. This constant can be used to subscript into the pre or post assignment arrays.
static int RVALUE
          Value of 1. This constant can be used to subscript into the pre or post assignment arrays.
 
Method Summary
 java.lang.Object clone()
          Creates a clone of this VWRosterDefinition object.
 VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength)
          Creates an exposed field on the roster, based on the supplied field name and type.
 VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames)
          Creates an index definition for the roster.
 void deleteFieldDefinition(java.lang.String theName)
          Deletes an exposed field from the roster.
 void deleteIndexDefinition(java.lang.String theName)
          Deletes an index from this roster.
 java.lang.String[] getCreateSecurity()
          Lists users and/or groups who have Create access to the roster.
 java.lang.String getDescription()
          Provides the description for this roster definition.
 VWExposedFieldDefinition[] getFields()
          Lists exposed field definitions for this roster definition.
 VWIndexDefinition[] getIndexes()
          Lists index definitions for this roster definition.
static java.lang.String getLocalizedString(int theConfigType)
          Gets a localized string representation of the config type (roster, queue, or log).
 java.lang.String getName()
          Gets the name of the roster.
 java.lang.String[] getReadSecurity()
          Lists the users and/or groups who currently have Read-only access to the roster.
 int getServerId()
          Gets the home server ID of this roster definition.
 java.lang.String[] getWriteSecurity()
          Lists users and/or groups who have Write access to the roster.
 boolean hasFieldName(java.lang.String fieldName)
          Determine whether a specified log, queue, or roster field exists.
static boolean isValid(int theConfigType)
          Validates the config type (a process engine table type) as a valid type.
static VWExposedFieldDefinition[] optionalSystemFields()
          Returns workflow system exposed fields that are marked as optional.
static VWExposedFieldDefinition[] optionalSystemFields(int theType)
          Gets optional exposed workflow system fields of type roster, queue, or log.
 void setCreateSecurity(java.lang.String[] theNames)
          Sets Create access for the roster.
 void setDescription(java.lang.String theDescription)
          Sets the description for this roster definition.
 void setReadSecurity(java.lang.String[] theNames)
          Sets Read-only access for the roster.
 void setServerId(int theNewServerId)
          Sets the home server ID of the roster.
 void setWriteSecurity(java.lang.String[] theNames)
          Sets Write access for the roster.
 java.lang.String toString()
          Returns the string version of the roster definition.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LVALUE

public static final int LVALUE
Value of 0. This constant can be used to subscript into the pre or post assignment arrays.

RVALUE

public static final int RVALUE
Value of 1. This constant can be used to subscript into the pre or post assignment arrays.

CONFIG_TYPE_ROSTER

public static final int CONFIG_TYPE_ROSTER
Value of 1. This constant indicates a roster configuration type.

CONFIG_TYPE_QUEUE

public static final int CONFIG_TYPE_QUEUE
Value of 2. This constant indicates a queue configuration type.

CONFIG_TYPE_LOG

public static final int CONFIG_TYPE_LOG
Value of 3. This constant indicates a log configuration type.
Method Detail

createFieldDefinition

public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName,
                                                      int theType,
                                                      int theLength)
                                               throws VWException
Creates an exposed field on the roster, based on the supplied field name and type. Use exposed fields to create index definitions. When specifying the name for the new exposed field, the name must:

Specified by:
createFieldDefinition in interface IVWTableDefinition
Overrides:
createFieldDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the field to expose.

theType - An integer value indicating the data type associated with the exposed field. Note that arrays, for any of the data types, are not allowed. Valid values are as follows:

  • 1: Integer (FIELD_TYPE_INT)
  • 2: String (FIELD_TYPE_STRING)
  • 4: Boolean (FIELD_TYPE_BOOLEAN)
  • 8: Float (FIELD_TYPE_FLOAT)
  • 16: Time/date (FIELD_TYPE_TIME)

theLength - An integer value specifying the length (number of bytes) of data stored if the data field is a string. If the field type is other than string, specify the 0 (zero).
Returns:
A VWExposedFieldDefinition object that contains roster definition information.
Throws:
VWException -  

deleteFieldDefinition

public void deleteFieldDefinition(java.lang.String theName)
                           throws VWException
Deletes an exposed field from the roster.
Specified by:
deleteFieldDefinition in interface IVWTableDefinition
Overrides:
deleteFieldDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the exposed field to delete from the roster.
Throws:
VWException - Thrown if the field specified in the theName parameter is not found.

createIndexDefinition

public VWIndexDefinition createIndexDefinition(java.lang.String theName,
                                               java.lang.String[] theFieldNames)
                                        throws VWException
Creates an index definition for the roster. Pass the index name and an array of system fields and/or user-defined exposed fields to create the definition of the concatenated index. Use at least one user-defined field name to create the index. When specifying the name for the index field, the name must:

Specified by:
createIndexDefinition in interface IVWTableDefinition
Parameters:
theName - The name of the new index field.
theFieldNames - A string array containing the system fields and/or user-defined exposed fields.
Throws:
VWException - Thrown if the system finds an error in the name or if the fields are undefined.

deleteIndexDefinition

public void deleteIndexDefinition(java.lang.String theName)
                           throws VWException
Deletes an index from this roster.
Specified by:
deleteIndexDefinition in interface IVWTableDefinition
Overrides:
deleteIndexDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the index to be deleted from the roster.
Throws:
VWException - Thrown if the system does not find the index name.

getFields

public VWExposedFieldDefinition[] getFields()
                                     throws VWException
Lists exposed field definitions for this roster definition.
Specified by:
getFields in interface IVWTableDefinition
Overrides:
getFields in class filenet.vw.api.VWTableDefinition
Returns:
An array of exposed field definition objects; if no defined exposed field exists, the method returns null.
Throws:
VWException -  

getIndexes

public VWIndexDefinition[] getIndexes()
                               throws VWException
Lists index definitions for this roster definition.
Specified by:
getIndexes in interface IVWTableDefinition
Overrides:
getIndexes in class filenet.vw.api.VWTableDefinition
Returns:
An array of index field definition objects; if no index field definition exists, the method returns null.
Throws:
VWException -  

getName

public java.lang.String getName()
Gets the name of the roster.
Specified by:
getName in interface IVWTableDefinition
Overrides:
getName in class filenet.vw.api.VWTableDefinition
Returns:
The name of the roster.

getServerId

public int getServerId()
Gets the home server ID of this roster definition.
Overrides:
getServerId in class filenet.vw.api.VWTableDefinition
Returns:
An integer value that represents the home server ID for the roster.

setServerId

public void setServerId(int theNewServerId)
                 throws VWException
Sets the home server ID of the roster. Server ID validation must occur after you transfer the information to the VWService.
Overrides:
setServerId in class filenet.vw.api.VWTableDefinition
Parameters:
theNewServerId - An integer value to be used as the new home server ID.
Throws:
VWException - Thrown if the method cannot set the home server ID of the roster.
See Also:
VWSystemConfiguration.getServerIDs()

getReadSecurity

public java.lang.String[] getReadSecurity()
Lists the users and/or groups who currently have Read-only access to the roster.
Overrides:
getReadSecurity in class filenet.vw.api.VWTableDefinition
Returns:
A list of users and groups who have Read-only access to the roster.

setReadSecurity

public void setReadSecurity(java.lang.String[] theNames)
                     throws VWException
Sets Read-only access for the roster. Pass the list of users and/or groups who are to have read access on the roster. This method does not validate user and group information; the system validates the information when it transfers the information to the VWService.
Parameters:
theNames - A list of names and/or groups who are to have Read-only access to the roster.
Throws:
VWException -  

getWriteSecurity

public java.lang.String[] getWriteSecurity()
Lists users and/or groups who have Write access to the roster.
Overrides:
getWriteSecurity in class filenet.vw.api.VWTableDefinition
Returns:
A list of names of users and/or groups who currently have Write access to the roster.

setWriteSecurity

public void setWriteSecurity(java.lang.String[] theNames)
                      throws VWException
Sets Write access for the roster. Pass the list of user names and/or groups who are to have Write access on the roster. This method does not validate user and group information; the system validates the information when it transfers the information to the VWService.
Parameters:
theNames - A list of names and/or groups who are to have Write access.
Throws:
VWException -  

getCreateSecurity

public java.lang.String[] getCreateSecurity()
Lists users and/or groups who have Create access to the roster.
Returns:
A list of names and/or groups who have create access to the roster.

setCreateSecurity

public void setCreateSecurity(java.lang.String[] theNames)
                       throws VWException
Sets Create access for the roster. Pass the list of user names and/or groups who are to have Create access on the roster. This method does not validate user and group information; the system validates the information when it transfers the information to the VWService.
Parameters:
theNames - A list of user names and/or groups who will be granted Create access on the roster.
Throws:
VWException - Thrown if the method cannot set Create access for the roster.

getDescription

public java.lang.String getDescription()
Provides the description for this roster definition.
Specified by:
getDescription in interface IVWTableDefinition
Overrides:
getDescription in class filenet.vw.api.VWTableDefinition
Returns:
The description for this roster definition

setDescription

public void setDescription(java.lang.String theDescription)
Sets the description for this roster definition.
Specified by:
setDescription in interface IVWTableDefinition
Overrides:
setDescription in class filenet.vw.api.VWTableDefinition
Parameters:
theDescription - The description for this roster definition

toString

public java.lang.String toString()
Returns the string version of the roster definition.
Specified by:
toString in interface IVWTableDefinition
Overrides:
toString in class filenet.vw.api.VWTableDefinition
Returns:
The roster name.

optionalSystemFields

public static VWExposedFieldDefinition[] optionalSystemFields()
                                                       throws VWException
Returns workflow system exposed fields that are marked as optional. These fields can be exposed on a roster.
Returns:
An array of VWExposedFieldDefinition objects that represent the optional workflow system fields.

clone

public java.lang.Object clone()
Creates a clone of this VWRosterDefinition object.
Overrides:
clone in class filenet.vw.api.VWTableDefinition
Returns:
A clone of this object instance.

optionalSystemFields

public static VWExposedFieldDefinition[] optionalSystemFields(int theType)
                                                       throws VWException
Gets optional exposed workflow system fields of type roster, queue, or log. These system fields are not required.
Parameters:
theType - Type of collection on which the optional system field is exposed, as follows:
    IVWCommandServer.QUERYTYPE_LOG
    IVWCommandServer.QUERYTYPE_QUEUE
    IVWCommandServer.QUERYTYPE_ROSTER
Returns:
Exposed field definitions of optional workflow system fields

hasFieldName

public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
Determine whether a specified log, queue, or roster field exists.
Parameters:
fieldName - Name of the log, queue, or roster field
Returns:
True if the data field exists
Throws:
VWException - Thrown if the field name parameter is null.

getLocalizedString

public static java.lang.String getLocalizedString(int theConfigType)
                                           throws VWException
Gets a localized string representation of the config type (roster, queue, or log).
Parameters:
theConfigType - An integer value associated with the config type.
Returns:
The localized version of the config type.
Throws:
VWException - Thrown if the config type value specified in the theConfigType parameter is invalid.

isValid

public static boolean isValid(int theConfigType)
Validates the config type (a process engine table type) as a valid type.
Parameters:
theConfigType - The integer value associated with the config type (roster, queue, or log) to be validated.
Returns:
true if the config type value specified in the theConfigType parameter is valid; otherwise, this method returns false.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.