|
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.VWQueueDefinition
Use this class to administer queue definitions.
Create and transfer queues with methods of the VWSystemConfiguration class.
Users can define exposed fields and indexes for two types of queue in document-centric workflow: process and user-centric. A process queue holds objects to be processed by an external workflow program. A user-centric queue is similar to the inbox for a user, in that the user's work resides in it.
Create queues with VWSystemConfiguration.createQueueDefinition(...)
. If you create
a new queue definition in a VWSystemConfiguration object, the queue
does not exist on the server until you successfully commit the
system configuration object to the workflow
server with VWSystemConfiguration.commit()
.
VWSession
,
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 |
QUEUE_ON_ALL_SERVERS
Signed integer value of -1. Not a queue type, this field value indicates that the queue is located on all servers. |
static int |
QUEUE_TYPE_PROCESS
Value of 1. This field value indicates a process queue type. |
static int |
QUEUE_TYPE_SYSTEM
Value of 3. This field value indicates a System queue type. |
static int |
QUEUE_TYPE_USER_CENTRIC
Value of 2. This field value indicates a user-centric queue type. |
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 VWQueueDefinition object. |
VWExposedFieldDefinition |
createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field in the queue, using the passed field name and type. |
VWIndexDefinition |
createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for the queue. |
VWOperationDefinition |
createOperation(java.lang.String theName)
Creates an operation definition in this queue. |
void |
deleteFieldDefinition(java.lang.String theName)
Deletes an exposed field from the queue. |
void |
deleteIndexDefinition(java.lang.String theName)
Deletes an index from this queue, given the index name. |
void |
deleteOperation(java.lang.String theName)
Deletes an operation from this queue, given the operation name. |
VWAttributeInfo |
getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
java.lang.String |
getDescription()
Gets the description associated with the queue definition. |
VWExposedFieldDefinition[] |
getFields()
Lists the exposed field definitions for the queue definition. |
VWIndexDefinition[] |
getIndexes()
Lists the index definitions for the queue definition. |
boolean |
getIsConnectorQueue()
Gets the isConnectorQueue flag, which indicates whether or not this queue is a connector. |
static java.lang.String |
getLocalizedString(int theQueueType)
Gets a localized string representation of the queue type. |
java.lang.String |
getName()
Gets the name of the queue. |
VWOperationDefinition |
getOperation(java.lang.String theName)
Gets the definition of an operation from this queue definition. |
VWOperationDefinition[] |
getOperations()
Lists the operation definitions for the queue definition. |
int |
getQueueType()
Gets the queue type of this queue definition. |
java.lang.String[] |
getReadSecurity()
Lists the user and/or groups who have Read access to the queue. |
int |
getServerId()
Gets the server ID of this queue definition. |
java.lang.String[] |
getWriteSecurity()
Lists the user and/or groups who have Write access to the queue. |
boolean |
hasFieldName(java.lang.String fieldName)
Determines whether or not the specified queue exposed field exists. |
static boolean |
isValid(int theQueueType)
Validates the queue type a valid type. |
static VWExposedFieldDefinition[] |
optionalSystemFields()
Gets definitions of optional exposed queue fields. |
static VWExposedFieldDefinition[] |
optionalSystemFields(int theType)
Gets optional exposed workflow system fields of type roster, queue, or log. |
void |
setAttributeInfo(VWAttributeInfo theAttributes)
Sets a VWAttribute object containing attributes for this object. |
void |
setDescription(java.lang.String theDescription)
Sets the description for this queue definition. |
void |
setIsConnectorQueue(boolean isConnectorQueue)
Sets the isConnectorQueue flag. |
void |
setReadSecurity(java.lang.String[] theNames)
Sets Read access privilege for the queue. |
void |
setServerId(int theNewServerId)
Sets the server ID for the queue. |
void |
setWriteSecurity(java.lang.String[] theNames)
Sets Write access privileges for the current queue. |
java.lang.String |
toString()
Gets the string version of the queue definition. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int QUEUE_TYPE_PROCESS
public static final int QUEUE_TYPE_USER_CENTRIC
public static final int QUEUE_TYPE_SYSTEM
public static final int QUEUE_ON_ALL_SERVERS
getQueueType()
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 indicating the data type
(arrays of types are not allowed):
theLength
- An integer value used to specify the length
(in bytes) of string data stored in the field Specify zero (0)
if the data field type not of type string.VWException
- Thrown if it cannot
return a VWExposedFieldDefinition object.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 being deleted from the queue.VWException
- Thrown if the
name specified in the theName parameter cannot be found.public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
A new index name should conform to the following guidelines:
createIndexDefinition
in interface IVWTableDefinition
theName
- The name of the index.theFieldNames
- A string containing an array of system
fields and/or user-defined exposed fields.VWException
- Thrown if the
index name specified in the theName parameter is not valid
or if the input fields are undefined.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
being deleted from the queue.VWException
- Thrown if the
index specified in the theName parameter cannot be found.public VWExposedFieldDefinition[] getFields() throws VWException
getFields
in interface IVWTableDefinition
getFields
in class filenet.vw.api.VWTableDefinition
VWException
- Thrown if it cannot
list the exposed field definitions for the queue definition.public VWOperationDefinition[] getOperations() throws VWException
VWException
- Thrown if this method cannot get existing
operation definitions for the queue definition.VWOperationDefinition
public VWOperationDefinition getOperation(java.lang.String theName) throws VWException
theName
- The name of the operation
that the returned definition describes.VWException
- Thrown if this method cannot find the
operation specified in the theName parameter.VWOperationDefinition
public void deleteOperation(java.lang.String theName) throws VWException
theName
- The name of the operation
to be deleted from the queue.VWException
- Thrown if the
operation specified in the theName parameter cannot be found.public VWOperationDefinition createOperation(java.lang.String theName) throws VWException
theName
- The name of the operation
being created.VWException
- Thrown if this method cannot create
an operation definition in this queue.VWOperationDefinition
public VWIndexDefinition[] getIndexes() throws VWException
getIndexes
in interface IVWTableDefinition
getIndexes
in class filenet.vw.api.VWTableDefinition
VWException
- Thrown if it cannot
list the index definitions for the queue definition.public java.lang.String getName()
getName
in interface IVWTableDefinition
getName
in class filenet.vw.api.VWTableDefinition
public int getQueueType()
public java.lang.String[] getReadSecurity()
getReadSecurity
in class filenet.vw.api.VWTableDefinition
public void setReadSecurity(java.lang.String[] theNames) throws VWException
theNames
- An array of strings containing names and/or
groups who are being granted Read access for the queue.VWException
- Thrown if it cannot
set Read access privilege for the current queue.public int getServerId()
getServerId
in class filenet.vw.api.VWTableDefinition
public void setServerId(int theNewServerId) throws VWException
setServerId
in class filenet.vw.api.VWTableDefinition
theNewServerId
- An integer value used to set as the new Server ID.VWException
- Thrown if the
server ID specified in the theNewServerId parameter is invalid.public java.lang.String[] getWriteSecurity()
getWriteSecurity
in class filenet.vw.api.VWTableDefinition
public void setWriteSecurity(java.lang.String[] theNames) throws VWException
Limitation: this method does not validate user or group information. User and group validation occurs after the information is transferred to the VWService.
theNames
- A string containing an array of names and/or
groups who are being granted Write access.VWException
- Thrown if it cannot set Write access
privileges for the queue.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 new
description for the queue definition.public java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class filenet.vw.api.VWTableDefinition
public static VWExposedFieldDefinition[] optionalSystemFields() throws VWException
VWException
- Thrown if it cannot
get the exposed fields for the queue which have been marked as
optional.public static java.lang.String getLocalizedString(int theQueueType) throws VWException
theQueueType
- An integer value associated with the queue type.VWException
- Thrown if the
queue type value specified in the theQueueType parameter is invalid.public static boolean isValid(int theQueueType)
theQueueType
- The integer value associated with the
queue type value to be validated.true
if the
queue type value specified in the theQueueType parameter is
valid; otherwise, this method returns false
.public boolean hasFieldName(java.lang.String fieldName) throws VWException
hasFieldName
in class filenet.vw.api.VWTableDefinition
fieldName
- The name of the field for the search.true
if the data
field name specified in the fieldName parameter exists;
otherwise, this method returns false
.VWException
- Thrown if the
field name specified in the fieldName parameter is null.public java.lang.Object clone()
VWQueueDefinition
object.clone
in class filenet.vw.api.VWTableDefinition
public VWAttributeInfo getAttributeInfo() throws VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributes) throws VWException
theAttributeInfo
- A VWAttribute object containing
attributes for this object, as paired labels (keywords) and
values in String format.VWException
- getAttributeInfo()
public boolean getIsConnectorQueue()
isConnectorQueue
- A boolean value true
means
this queue is an connector queue; false
otherwise.public void setIsConnectorQueue(boolean isConnectorQueue)
isConnectorQueue
- A boolean value true
means
this queue is an connector queue; false
otherwise.public static VWExposedFieldDefinition[] optionalSystemFields(int theType) throws VWException
theType
- Type of collection on which the
optional system field is exposed, as follows:
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |