filenet.vw.api

Interface IVWTableDefinition

All Known Implementing Classes:

VWLogDefinition, VWQueueDefinition, VWRosterDefinition, VWTableDefinition

public interface IVWTableDefinition

The VWTableDefinition class provides the definition for database tables. Tables are used for queues, rosters, and logs

Method Summary

Modifier and Type	Method and Description
VWExposedFieldDefinition	createFieldDefinition(java.lang.String theName, int theType, int theLength) Creates an exposed field by passing in a field name and the type.
VWIndexDefinition	createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) Creates an index definition for this queue.
void	deleteFieldDefinition(java.lang.String theName) Provides the ability to delete exposed fields from the queue.
void	deleteIndexDefinition(java.lang.String theName) Provides the ability to delete indexes from this queue.
java.lang.String	getDescription() Provides the description for this table definition.
VWExposedFieldDefinition[]	getFields() Provides an array of exposed field definitions for this queue definition.
VWIndexDefinition[]	getIndexes() Provides an array of index definitions for this queue definition
java.lang.String	getName() Provides the name of the queue.
void	setDescription(java.lang.String theDescription) Sets the description for this table definition
java.lang.String	toString() Provides a string version of the table definition.

Method Detail

createFieldDefinition

VWExposedFieldDefinition createFieldDefinition(java.lang.String theName,
                                               int theType,
                                               int theLength)
                                        throws VWException

Creates an exposed field by passing in a field name and the type. Exposed fields can be used to create index definitions. An exposed field name must not start with F_ and also be alphanumeric. Underscore characters are acceptable anywhere after the first letter in the name.

Parameters:

theName - the name of the field.

theType - the type of the data. FIELD_TYPE_INT=1,FIELD_TYPE_STRING=2,FIELD_TYPE_BOOLEAN=3, FIELD_TYPE_FLOAT = 4, FIELD_TYPE_TIME=5. Arrays of these types are not acceptable.

theLength - If data type is a string, the length of data stored. Pass in 0, for all other types.

Returns:

VWExposedDefinition a exposed definition for this queue.

Throws:

VWException, - if there are errors.

VWException

deleteFieldDefinition

void deleteFieldDefinition(java.lang.String theName)
                    throws VWException

Provides the ability to delete exposed fields from the queue.

Parameters:

theName - the name of the exposed field to be deleted from the queue.

Throws:

VWException, - if name not found.

VWException

createIndexDefinition

VWIndexDefinition createIndexDefinition(java.lang.String theName,
                                        java.lang.String[] theFieldNames)
                                 throws VWException

Creates an index definition for this queue. The index name is passed in and an array of System fields and/or user defined exposed fields is passed in to create the definition of the concatenated index. At least one field name is required to create the index. Index name must not start with F_ and also be alphanumeric. Underscore characters are acceptable anywhere after the first letter in the name.

Parameters:

theName - The name of the field.

theFieldNames - An array of System fields and/or user defined exposed fields.

Throws:

VWException, - if errors found in the name or undefined fields used to define the index.

VWException

deleteIndexDefinition

void deleteIndexDefinition(java.lang.String theName)
                    throws VWException

Provides the ability to delete indexes from this queue.

Parameters:

theName - the name of the index to be deleted from the queue.

Throws:

VWException, - if index not found.

VWException

getFields

VWExposedFieldDefinition[] getFields()
                              throws VWException

Provides an array of exposed field definitions for this queue definition.

Returns:

an array of exposed field definitions. Null is returned, if there are no exposed field definitions are defined.

Throws:

Thrown - if there is an error.

VWException

getIndexes

VWIndexDefinition[] getIndexes()
                        throws VWException

Provides an array of index definitions for this queue definition

Returns:

an array of index field definitions. Null is returned, if there are no index field definitions are defined.

Throws:

Thrown - if there is an error.

VWException

getDescription

java.lang.String getDescription()

Provides the description for this table definition.

Returns:

the description for this table definition.

setDescription

void setDescription(java.lang.String theDescription)

Sets the description for this table definition

Parameters:

theDescription - a description for this table definition.

getName

java.lang.String getName()

Provides the name of the queue.

Returns:

the name of the queue.

toString

java.lang.String toString()

Provides a string version of the table definition.

Overrides:

toString in class java.lang.Object

Returns:

the table name