VWLogDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWTableDefinition
- - 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, IWFCaseFolder, IWFCaseTask, LVALUE, RVALUE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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 authored name of this log.
`boolean`	`hasChanged()` Indicate whether this log has changed.
`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)` Deprecated. Use `VWXMLConfiguration.makeXMLBlock(IVWtoXML[])`.

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
  - 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:
    - Begin with characters other than "F_". The prefix is reserved for system fields.
    - Contain no less than 1 (one) and no more than 30 characters.
    - Contain no characters other than letters or numbers; however, an underscore ("_") is acceptable after the first letter in the name.
    - Avoid special characters.
    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 - A String containing the name of the exposed field to be deleted from the log.
    
    Throws:
    
    VWException - Thrown if the field name specified cannot be found.
  - createIndexDefinition
```
public VWIndexDefinition createIndexDefinition(java.lang.String theName,
                                               java.lang.String[] theFieldNames)
                                        throws VWException
```
    Creates an index definition for the specified log.
    Specify an array of system fields and/or 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:
    - Begin with characters other than "F_". The prefix is reserved for system fields.
    - Contain no less than 1 (one) and no more than 30 characters.
    - Contain no characters other than letters or numbers; however, an underscore ("_") is acceptable after the first letter in the name.
    - Avoid special characters.
    Specified by:
    
    createIndexDefinition in interface IVWTableDefinition
    
    Specified by:
    
    createIndexDefinition in class VWTableDefinition
    
    Parameters:
    
    theName - A String containing the name of the index field.
    
    theFieldNames - A String array of system fields and/or user-defined exposed fields.
    
    Returns:
    
    A VWIndexDefinition for 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 - A String containing the name of the index to be deleted from the log.
    
    Throws:
    
    VWException - Thrown if the index cannot be found.
  - 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 authored name of this log.
    
    Specified by:
    
    getName in interface IVWTableDefinition
    
    Overrides:
    
    getName in class VWTableDefinition
    
    Returns:
    
    A String containing the authored name of this log.
  - 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
```
    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.
    
    See Also:
    
    VWXMLConfiguration
  - hasChanged
```
public boolean hasChanged()
                   throws VWException
```
    Indicate whether this log has changed.
    
    Returns:
    
    A value of true, if this log has changed; false otherwise.
    
    Throws:
    
    VWException - Thrown if an error occurs.
    
    Since:
    
    PE 4.5.0
  - optionalSystemFields
```
public static VWExposedFieldDefinition[] optionalSystemFields()
                                                       throws VWException
```
    Returns workflow system exposed fields, which are marked as optional. The optional system fields can be exposed in 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.

Fields inherited from class filenet.vw.api.VWTableDefinition

Methods inherited from class filenet.vw.api.VWTableDefinition

Methods inherited from class java.lang.Object

Methods inherited from interface filenet.vw.api.IVWTableDefinition

createFieldDefinition

deleteFieldDefinition

createIndexDefinition

deleteIndexDefinition

getField

getIndex

getName

getDescription

setDescription

toString

toXML

hasChanged

optionalSystemFields

clone