|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWTableDefinition
public abstract class VWTableDefinition
Defines database tables for use with queues, rosters, and logs.
The following methods in the WQueueDefinition and VWRosterDefinition classes set read and write access permissions for users and groups, using VWParticipant objects:
getReadSecurityPx()
getWriteSecurityPx()
getReadSecurity()
getWriteSecurity()
Field 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 | |
---|---|
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 VWTableDefinition object. |
VWExposedFieldDefinition |
createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Create an exposed field by input of a field name and data type. |
VWIndexDefinition |
createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Create the index definition DMM addded because of IVWTableDef |
void |
deleteFieldDefinition(java.lang.String theName)
Delete an exposed field from one of the following: log, queue, or roster. |
void |
deleteIndexDefinition(java.lang.String theName)
Delete an index from one of the following: log, queue, or roster. |
java.lang.String |
getDescription()
Get the description for this table definition. |
VWExposedFieldDefinition[] |
getFields()
Get an array of exposed field definitions for this table definition. |
VWIndexDefinition[] |
getIndexes()
Get an array of index definitions for one of the following Process Engine table types: log, queue, or roster 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 for one of the following: log, queue, or roster. |
java.lang.String[] |
getReadSecurity()
Returns a String array of users and/or groups who have read access. |
VWParticipant[] |
getReadSecurityPx()
Returns an array of VWParticipant objects that specifies users and/or groups who have read access. |
int |
getServerId()
Get the server ID location for one of the following: log, queue, or roster. |
java.lang.String[] |
getWriteSecurity()
Returns a String array of users and/or groups who have write access. |
VWParticipant[] |
getWriteSecurityPx()
Returns an array of VWParticipant objects that specifies users and/or groups who have write access. |
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(int theType)
Gets optional exposed workflow system fields of type roster, queue, or log. |
void |
setDescription(java.lang.String theDescription)
Set the description for this table definition. |
void |
setServerId(int theNewServerId)
Set the server ID location for one of the following: log, queue, or roster. |
java.lang.String |
toString()
Get the string version of the table 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 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
theName
- Name of the exposed fieldtheType
- Integer value that represents the type of the data, as follows:Value | Data type |
---|---|
1 | FIELD_TYPE_INT |
2 | FIELD_TYPE_STRING |
4 | FIELD_TYPE_BOOLEAN |
8 | FIELD_TYPE_FLOAT |
16 | FIELD_TYPE_TIME |
theLength
- Number of bytes (length) of data stored, if data type is a stringVWException
public void deleteFieldDefinition(java.lang.String theName) throws VWException
deleteFieldDefinition
in interface IVWTableDefinition
theName
- Name of the exposed field to be deleted from the
log, queue, or roster
VWException
- Thrown whenever the system does not find
the name.public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
createIndexDefinition
in interface IVWTableDefinition
theName
- theFieldNames
-
VWException
public void deleteIndexDefinition(java.lang.String theName) throws VWException
deleteIndexDefinition
in interface IVWTableDefinition
theName
- Name of the index to be deleted from the
log, queue, or roster
VWException
- Thrown whenever the system does not find the
index.public VWExposedFieldDefinition[] getFields() throws VWException
getFields
in interface IVWTableDefinition
VWException
public VWIndexDefinition[] getIndexes() throws VWException
getIndexes
in interface IVWTableDefinition
VWException
public java.lang.String getName()
getName
in interface IVWTableDefinition
public java.lang.String[] getReadSecurity()
public VWParticipant[] getReadSecurityPx() throws VWException
VWException
public int getServerId()
public void setServerId(int theNewServerId) throws VWException
theNewServerId
- New server ID
VWException
- Thrown if theNewServerId input is invalid.public java.lang.String[] getWriteSecurity()
public VWParticipant[] getWriteSecurityPx() throws VWException
VWException
public java.lang.String getDescription()
getDescription
in interface IVWTableDefinition
public void setDescription(java.lang.String theDescription)
setDescription
in interface IVWTableDefinition
theDescription
- Description for this table definitionpublic java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class java.lang.Object
public static VWExposedFieldDefinition[] optionalSystemFields(int theType) throws VWException
theType
- Type of collection on which the
optional system field is exposed, as follows:
VWException
public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- Name of the log, queue, or roster field
VWException
- Thrown if the field name parameter is null.public java.lang.Object clone()
VWTableDefinition
object.
clone
in class java.lang.Object
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
.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |