Process API

filenet.vw.api
Class VWLogDefinition

java.lang.Object
  extended by filenet.vw.api.VWTableDefinition
      extended by filenet.vw.api.VWLogDefinition
All Implemented Interfaces:
IVWTableDefinition, IVWtoXML, java.io.Serializable, java.lang.Cloneable

public final class VWLogDefinition
extends VWTableDefinition
implements java.io.Serializable, IVWTableDefinition, java.lang.Cloneable, IVWtoXML

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
 
Fields inherited from class filenet.vw.api.VWTableDefinition
CONFIG_TYPE_LOG, CONFIG_TYPE_QUEUE, CONFIG_TYPE_ROSTER, LVALUE, RVALUE
 
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 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 description for this log definition.
 VWExposedFieldDefinition getField(java.lang.String name)
          Returns the specified exposed field definition for this instance.
 VWIndexDefinition getIndex(java.lang.String name)
          Gets the index definition specified for this log definition.
 java.lang.String getName()
          Gets the name of the log.
static VWExposedFieldDefinition[] optionalSystemFields()
          Returns workflow system exposed fields, which are marked as optional.
 void setDescription(java.lang.String theDescription)
          Sets the description for the log definition.
 java.lang.String toString()
          Returns the string representation of the log definition.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 
Methods inherited from class filenet.vw.api.VWTableDefinition
getFields, getIndexes, getLocalizedString, getReadSecurity, getReadSecurityPx, getServerId, getWriteSecurity, getWriteSecurityPx, hasFieldName, isValid, optionalSystemFields, setServerId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface filenet.vw.api.IVWTableDefinition
getFields, getIndexes
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.

Returns:
the file date

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 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 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
Overrides:
createIndexDefinition in class VWTableDefinition
Parameters:
theName - The name of the index field.
theFieldNames - A string containing an array of system fields and/or user-defined exposed fields.
Returns:
The new index definition
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 VWTableDefinition
Parameters:
theName - The name of the index to be deleted from the log.
Throws:
VWException - Thrown if the system cannot find the index.

getField

public VWExposedFieldDefinition getField(java.lang.String name)
                                  throws VWException
Returns the specified exposed field definition for this instance. If a translation source exists, the authored field information is translated.

Parameters:
name - A String containing the field name.
Returns:
The VWExposedFieldDefinition object for the specified field. If a translation source exists the translated information for the field is returned; otherwise, the authored information is returned. If the exposed field does not exist, null is returned.
Throws:
VWException
Since:
P8 4.0

getIndex

public VWIndexDefinition getIndex(java.lang.String name)
                           throws VWException
Gets the index definition specified for this log definition. If a translation source exists, the authored index information is translated.

Parameters:
name - A String containing the name of the index.
Returns:
The VWIndexDefinition for the index name specified. If a translation source exists the translated index information is returned; otherwise, the authored information is returned. If the index does not exist, null is returned.
Throws:
VWException
Since:
P8 4.0

getName

public java.lang.String getName()
Gets the name of the log. If a translation source exists, the authored name is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Specified by:
getName in interface IVWTableDefinition
Overrides:
getName in class VWTableDefinition
Returns:
A String containing the translated name of the log, if a translation source exists; otherwise the authored name is returned.

getDescription

public java.lang.String getDescription()
Gets the description for this log definition. If a translation source exists, the authored description string is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Specified by:
getDescription in interface IVWTableDefinition
Overrides:
getDescription in class VWTableDefinition
Returns:
A String containing the translated description, if a translation source exists; otherwise the authored description is returned.

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 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 VWTableDefinition
Returns:
A string representation of the log definition.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
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.
See Also:
VWXMLUtil

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.
Throws:
VWException

clone

public java.lang.Object clone()
Creates a clone of this VWLogDefinition object.

Overrides:
clone in class VWTableDefinition
Returns:
A clone of this instance.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.