Process Class Relationships

filenet.vw.api
Class VWLogDefinition

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

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

VWLogDefinition administers properties of event log definitions for the default event log and roster event logs. Note that event logs may be created and retrieved with methods of the VWSystemConfiguration class.

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 VWLogDefinition object.
 VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength)
          Creates an exposed field on this log from the supplied field name and type.
 VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames)
          Creates an index definition for the specified log.
 void deleteFieldDefinition(java.lang.String theName)
          Deletes an exposed field from the log.
 void deleteIndexDefinition(java.lang.String theName)
          Deletes an index from the log.
 java.lang.String getDescription()
          Gets the string description for this log definition.
 VWExposedFieldDefinition[] getFields()
          Lists exposed field definitions for the log definition.
 VWIndexDefinition[] getIndexes()
          Lists index definitions for the log 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 log.
 java.lang.String[] getReadSecurity()
          Lists the users and/or groups who have Read access for one of the following: log, queue, or roster.
 int getServerId()
          Get the server ID location for one of the following: log, queue, or roster.
 java.lang.String[] getWriteSecurity()
          Lists the users and/or groups who have Write access for one of the following: log, queue, or 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, which are marked as optional.
static VWExposedFieldDefinition[] optionalSystemFields(int theType)
          Gets optional exposed workflow system fields of type roster, queue, or log.
 void setDescription(java.lang.String theDescription)
          Sets the description for the log definition.
 void setServerId(int theNewServerId)
          Set the server ID location for one of the following: log, queue, or roster.
 java.lang.String toString()
          Returns the string representation of the log 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 this log from the supplied field name and type. Use exposed fields to create index definitions. An exposed field name must conform to the following guidelines:

Specified by:
createFieldDefinition in interface IVWTableDefinition
Overrides:
createFieldDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the field.
theType - An integer value specifying a valid field data type. Note: Arrays are not allowed.
Valid type values are:

  • 1: Integer (FIELD_TYPE_INT)
  • 2: String (FIELD_TYPE_STRING)
  • 4: Boolean (FIELD_TYPE_BOOLEAN)
  • 8: Float (FIELD_TYPE_FLOAT)
  • 16: Time (FIELD_TYPE_TIME)
theLength - An integer value specifying the length of the string data stored in the data field. The parameter is valid if the data type is string; otherwise, you must specify 0 (zero) for any other data type.
Returns:
An VWExposedDefinition object.
Throws:
VWException - Causes include an error in the supplied field name or type.

deleteFieldDefinition

public void deleteFieldDefinition(java.lang.String theName)
                           throws VWException
Deletes an exposed field from the log.
Specified by:
deleteFieldDefinition in interface IVWTableDefinition
Overrides:
deleteFieldDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the exposed field slated for deletion from the log.
Throws:
VWException - Thrown if the system cannot find the field name specified in the theName parameter.

createIndexDefinition

public VWIndexDefinition createIndexDefinition(java.lang.String theName,
                                               java.lang.String[] theFieldNames)
                                        throws VWException
Creates an index definition for the specified log. Input the index name as an array of system fields and/or input user-defined exposed fields to create the definition of the concatenated index. Use at least one field name to create the index.

An index name must conform to the following guidelines:

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

deleteIndexDefinition

public void deleteIndexDefinition(java.lang.String theName)
                           throws VWException
Deletes an index from the log.
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 log.
Throws:
VWException - Thrown if the system cannot find the index.

getFields

public VWExposedFieldDefinition[] getFields()
                                     throws VWException
Lists exposed field definitions for the log definition.
Specified by:
getFields in interface IVWTableDefinition
Overrides:
getFields in class filenet.vw.api.VWTableDefinition
Returns:
An array of exposed field definitions; the array value is null if no user-defined exposed fields exist.
Throws:
VWException -  

getIndexes

public VWIndexDefinition[] getIndexes()
                               throws VWException
Lists index definitions for the log definition.
Specified by:
getIndexes in interface IVWTableDefinition
Overrides:
getIndexes in class filenet.vw.api.VWTableDefinition
Returns:
An array of index field definitions; the array value is null if no user-defined index field definitions exist.
Throws:
VWException -  

getName

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

getDescription

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

setDescription

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

toString

public java.lang.String toString()
Returns the string representation of the log definition.
Specified by:
toString in interface IVWTableDefinition
Overrides:
toString in class filenet.vw.api.VWTableDefinition
Returns:
A string representation of the log definition.

optionalSystemFields

public static VWExposedFieldDefinition[] optionalSystemFields()
                                                       throws VWException
Returns workflow system exposed fields, which are marked as optional. The optional system fields can be exposed on a log. These system fields are not required.
Returns:
An array of exposed field definitions of optional workflow system fields.

clone

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

getReadSecurity

public java.lang.String[] getReadSecurity()
Lists the users and/or groups who have Read access for one of the following: log, queue, or roster.
Returns:
readSecurity Array of users and/or groups who have read access

getServerId

public int getServerId()
Get the server ID location for one of the following: log, queue, or roster.

setServerId

public void setServerId(int theNewServerId)
                 throws VWException
Set the server ID location for one of the following: log, queue, or roster. The system validates the server ID only upon transfer of the information to the VWService.
Parameters:
theNewServerId - New server ID
Throws:
VWException - Thrown if theNewServerId input is invalid.

getWriteSecurity

public java.lang.String[] getWriteSecurity()
Lists the users and/or groups who have Write access for one of the following: log, queue, or roster.
Returns:
An array of users and/or groups who have Write access to this log definition.

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.