|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWTableDefinition
filenet.vw.api.VWLogDefinition
public final class VWLogDefinition
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.
VWSystemConfiguration
,
Serialized FormField 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 |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength) throws VWException
createFieldDefinition
in interface IVWTableDefinition
createFieldDefinition
in class VWTableDefinition
theName
- The name of the field.theType
- An integer value specifying a valid field data type.
Note: Arrays are not allowed.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.
VWException
- Causes include an error in the
supplied field name or type.public void deleteFieldDefinition(java.lang.String theName) throws VWException
deleteFieldDefinition
in interface IVWTableDefinition
deleteFieldDefinition
in class VWTableDefinition
theName
- The name of the exposed field
slated for deletion from the log.
VWException
- Thrown if the system
cannot find the field name specified in the theName parameter.public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
An index name must conform to the following guidelines:
createIndexDefinition
in interface IVWTableDefinition
createIndexDefinition
in class VWTableDefinition
theName
- The name of the index field.theFieldNames
- A string containing an array of system
fields and/or user-defined exposed fields.
VWException
- Thrown if the name specified
in the theName parameter is invalid or if there are undefined
fields in the index.public void deleteIndexDefinition(java.lang.String theName) throws VWException
deleteIndexDefinition
in interface IVWTableDefinition
deleteIndexDefinition
in class VWTableDefinition
theName
- The name of the index to be
deleted from the log.
VWException
- Thrown if the
system cannot find the index.public VWExposedFieldDefinition getField(java.lang.String name) throws VWException
name
- A String containing the field name.
VWException
public VWIndexDefinition getIndex(java.lang.String name) throws VWException
name
- A String containing the name of the index.
VWException
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
getName
in interface IVWTableDefinition
getName
in class VWTableDefinition
public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
getDescription
in interface IVWTableDefinition
getDescription
in class VWTableDefinition
public void setDescription(java.lang.String theDescription)
setDescription
in interface IVWTableDefinition
setDescription
in class VWTableDefinition
theDescription
- The description of the
log definition.public java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class VWTableDefinition
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public static VWExposedFieldDefinition[] optionalSystemFields() throws VWException
VWException
public java.lang.Object clone()
VWLogDefinition
object.
clone
in class VWTableDefinition
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |