|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWTableDefinition | +--filenet.vw.api.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 | |
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 |
public static final int LVALUE
public static final int RVALUE
public static final int CONFIG_TYPE_ROSTER
public static final int CONFIG_TYPE_QUEUE
public static final int CONFIG_TYPE_LOG
Method Detail |
public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength) throws VWException
createFieldDefinition
in interface IVWTableDefinition
createFieldDefinition
in class filenet.vw.api.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 filenet.vw.api.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
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 filenet.vw.api.VWTableDefinition
theName
- The name of the index to be
deleted from the log.VWException
- Thrown if the
system cannot find the index.public VWExposedFieldDefinition[] getFields() throws VWException
getFields
in interface IVWTableDefinition
getFields
in class filenet.vw.api.VWTableDefinition
VWException
- public VWIndexDefinition[] getIndexes() throws VWException
getIndexes
in interface IVWTableDefinition
getIndexes
in class filenet.vw.api.VWTableDefinition
VWException
- public java.lang.String getName()
getName
in interface IVWTableDefinition
getName
in class filenet.vw.api.VWTableDefinition
public java.lang.String getDescription()
getDescription
in interface IVWTableDefinition
getDescription
in class filenet.vw.api.VWTableDefinition
public void setDescription(java.lang.String theDescription)
setDescription
in interface IVWTableDefinition
setDescription
in class filenet.vw.api.VWTableDefinition
theDescription
- The description of the
log definition.public java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class filenet.vw.api.VWTableDefinition
public static VWExposedFieldDefinition[] optionalSystemFields() throws VWException
public java.lang.Object clone()
VWLogDefinition
object.clone
in class filenet.vw.api.VWTableDefinition
public java.lang.String[] getReadSecurity()
public int getServerId()
public void setServerId(int theNewServerId) throws VWException
theNewServerId
- New server IDVWException
- Thrown if theNewServerId input is invalid.public java.lang.String[] getWriteSecurity()
public static VWExposedFieldDefinition[] optionalSystemFields(int theType) throws VWException
theType
- Type of collection on which the
optional system field is exposed, as follows:
public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- Name of the log, queue, or roster fieldVWException
- Thrown if the field name parameter is null.public static java.lang.String getLocalizedString(int theConfigType) throws VWException
theConfigType
- An integer value associated
with the config type.VWException
- Thrown if the
config type value specified in the theConfigType
parameter is invalid.public static boolean isValid(int theConfigType)
theConfigType
- The integer value associated with the
config type (roster, queue, or log) to be validated.true
if the config type value specified in the theConfigType
parameter is valid; otherwise, this method returns
false
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |