Process Class Relationships

filenet.vw.api
Class VWQueueDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWTableDefinition
        |
        +--filenet.vw.api.VWQueueDefinition
All Implemented Interfaces:
java.lang.Cloneable, IVWTableDefinition, java.io.Serializable

public final class VWQueueDefinition
extends filenet.vw.api.VWTableDefinition
implements java.io.Serializable, IVWTableDefinition, java.lang.Cloneable

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 user 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().

Since:
VWWS3.10
See Also:
VWSession, VWSystemConfiguration, Serialized Form

Field Summary
static int CONFIG_TYPE_LOG
          Integer value of 3. This field value indicates a log configuration type.
static int CONFIG_TYPE_QUEUE
          Integer value of 2. This field value indicates a queue configuration type.
static int CONFIG_TYPE_ROSTER
          Integer value of 1. This field value indicates a roster configuration type.
static int LVALUE
          Integer 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
          Integer value of 1. This field value indicates a process queue type.
static int QUEUE_TYPE_SYSTEM
          Integer value of 3. This field value indicates a System queue type.
static int QUEUE_TYPE_USER_CENTRIC
          Integer value of 2. This field value indicates a User-centric queue type.
static int RVALUE
          Integer 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.
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)
          Get optional exposed workflow system fields for one among: 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 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

QUEUE_TYPE_PROCESS

public static final int QUEUE_TYPE_PROCESS
Integer value of 1. This field value indicates a process queue type. A process queue holds objects processed by external workflow applications.

QUEUE_TYPE_USER_CENTRIC

public static final int QUEUE_TYPE_USER_CENTRIC
Integer value of 2. This field value indicates a User-centric queue type. User-centric queues are associated with a particular workflow participant. The queue acts like the inbox for the workflow participant.

QUEUE_TYPE_SYSTEM

public static final int QUEUE_TYPE_SYSTEM
Integer value of 3. This field value indicates a System queue type. System queues are configured by the system.

QUEUE_ON_ALL_SERVERS

public static final 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. For example, User-centric queues are on all servers.
See Also:
getQueueType()

LVALUE

public static final int LVALUE
Integer value of 0: this constant can be used to subscript into the pre or post assignment arrays.

RVALUE

public static final int RVALUE
Integer value of 1: this constant can be used to subscript into the pre or post assignment arrays.

CONFIG_TYPE_ROSTER

public static final int CONFIG_TYPE_ROSTER
Integer value of 1. This field value indicates a roster configuration type.

CONFIG_TYPE_QUEUE

public static final int CONFIG_TYPE_QUEUE
Integer value of 2. This field value indicates a queue configuration type.

CONFIG_TYPE_LOG

public static final int CONFIG_TYPE_LOG
Integer value of 3. This field value indicates a log configuration type.
Method Detail

createFieldDefinition

public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName,
                                                      int theType,
                                                      int theLength)
                                               throws VWException
Creates an exposed field in the queue, using the passed field name and type. Use exposed fields to create index definitions. When creating the name for the new exposed field, the name must:

Specified by:
createFieldDefinition in interface IVWTableDefinition
Overrides:
createFieldDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the field.
theType - An integer value indicating the data type (arrays of types are not allowed):

  • 1: Integer(FIELD_TYPE_INT)
  • 2: String(FIELD_TYPE_STRING)
  • 4: Boolean(FIELD_TYPE_BOOLEAN)
  • 8: Float(FIELD_TYPE_FLOAT)
  • 16: Time(FIELD_TYPE_TIME)

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.
Returns:
A VWExposedFieldDefinition object, which represents an exposed definition for the queue.
Throws:
VWException - Thrown if it cannot return a VWExposedFieldDefinition object.

deleteFieldDefinition

public void deleteFieldDefinition(java.lang.String theName)
                           throws VWException
Deletes an exposed field from the queue.
Specified by:
deleteFieldDefinition in interface IVWTableDefinition
Overrides:
deleteFieldDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the exposed field being deleted from the queue.
Throws:
VWException - Thrown if the name specified in the theName parameter cannot be found.

createIndexDefinition

public VWIndexDefinition createIndexDefinition(java.lang.String theName,
                                               java.lang.String[] theFieldNames)
                                        throws VWException
Creates an index definition for the queue. While you must use at least one field name to create the index, you can pass the index name and an array of system fields and / or user-defined exposed fields to create the definition of a concatenated index.

A new index name should conform to the following guidelines:

Specified by:
createIndexDefinition in interface IVWTableDefinition
Parameters:
theName - The name of the index.
theFieldNames - A string containing an array of system fields and / or user-defined exposed fields.
Throws:
VWException - Thrown if the index name specified in the theName parameter is not valid or if the input fields are undefined.

deleteIndexDefinition

public void deleteIndexDefinition(java.lang.String theName)
                           throws VWException
Deletes an index from this queue, given the index name.
Specified by:
deleteIndexDefinition in interface IVWTableDefinition
Overrides:
deleteIndexDefinition in class filenet.vw.api.VWTableDefinition
Parameters:
theName - The name of the index being deleted from the queue.
Throws:
VWException - Thrown if the index specified in the theName parameter cannot be found.

getFields

public VWExposedFieldDefinition[] getFields()
                                     throws VWException
Lists the exposed field definitions for the queue definition.
Specified by:
getFields in interface IVWTableDefinition
Overrides:
getFields in class filenet.vw.api.VWTableDefinition
Returns:
An array of VWExposedFieldDefinition objects that represent the exposed field definitions. If no exposed field definitions exist, this method returns null.
Throws:
VWException - Thrown if it cannot list the exposed field definitions for the queue definition.

getOperations

public VWOperationDefinition[] getOperations()
                                      throws VWException
Lists the operation definitions for the queue definition.
Returns:
An array of VWOperationDefinition objects containing the operation definitions for this queue definition. If no operation definitions exist, this method returns null.
Throws:
VWException - Thrown if this method cannot get existing operation definitions for the queue definition.
See Also:
VWOperationDefinition

getOperation

public VWOperationDefinition getOperation(java.lang.String theName)
                                   throws VWException
Gets the definition of an operation from this queue definition.
Parameters:
theName - The name of the operation that the returned definition describes.
Returns:
A VWOperationDefinition object that represents the operation specified by the theName parameter.
Throws:
VWException - Thrown if this method cannot find the operation specified in the theName parameter.
See Also:
VWOperationDefinition

deleteOperation

public void deleteOperation(java.lang.String theName)
                     throws VWException
Deletes an operation from this queue, given the operation name.
Parameters:
theName - The name of the operation to be deleted from the queue.
Throws:
VWException - Thrown if the operation specified in the theName parameter cannot be found.

createOperation

public VWOperationDefinition createOperation(java.lang.String theName)
                                      throws VWException
Creates an operation definition in this queue.
Parameters:
theName - The name of the operation being created.
Returns:
A VWOperationDefinition object that is the newly created VWOperationDefinition.
Throws:
VWException - Thrown if this method cannot create an operation definition in this queue.
See Also:
VWOperationDefinition

getIndexes

public VWIndexDefinition[] getIndexes()
                               throws VWException
Lists the index definitions for the queue definition.
Specified by:
getIndexes in interface IVWTableDefinition
Overrides:
getIndexes in class filenet.vw.api.VWTableDefinition
Returns:
An array of VWIndexDefinition objects. If no index definitions exist, this method returns null.
Throws:
VWException - Thrown if it cannot list the index definitions for the queue definition.

getName

public java.lang.String getName()
Gets the name of the queue.
Specified by:
getName in interface IVWTableDefinition
Overrides:
getName in class filenet.vw.api.VWTableDefinition
Returns:
The name of the queue.

getQueueType

public int getQueueType()
Gets the queue type of this queue definition.
Returns:
An integer value indicating the queue type. Valid queue types are:

  • 1: QUEUE_TYPE_PROCESS
  • 2: QUEUE_TYPE_USER_CENTRIC
  • 3: QUEUE_TYPE_SYSTEM


getReadSecurity

public java.lang.String[] getReadSecurity()
Lists the user and / or groups who have read access to the queue.
Overrides:
getReadSecurity in class filenet.vw.api.VWTableDefinition
Returns:
An array of strings containing users and / or groups who have read access privileges for the queue.

setReadSecurity

public void setReadSecurity(java.lang.String[] theNames)
                     throws VWException
Sets read access privilege for the queue. Pass the list of users and / or groups to whom read access is being granted on the queue. This method does not validate user and group information; however, the user and group information is validated when the information is transferred to the VWService.
Parameters:
theNames - A array of strings containing names and / or groups who are being granted read access for the queue.
Throws:
VWException - Thrown if it cannot set read access privilege for the current queue.

getServerId

public int getServerId()
Gets the server ID of this queue definition.
Overrides:
getServerId in class filenet.vw.api.VWTableDefinition
Returns:
An integer value for the server ID.

setServerId

public void setServerId(int theNewServerId)
                 throws VWException
Sets the server ID for the queue. Server ID validation occurs only after the information is transferred to the VWService.
Overrides:
setServerId in class filenet.vw.api.VWTableDefinition
Parameters:
theNewServerId - An integer value used to set as the new Server ID.
Throws:
VWException - Thrown if the server ID specified in the theNewServerId parameter is invalid.

getWriteSecurity

public java.lang.String[] getWriteSecurity()
Lists the user and / or groups who have write access to the queue.
Overrides:
getWriteSecurity in class filenet.vw.api.VWTableDefinition
Returns:
An array of strings containing a collection of users and / or groups who have write access for the queue.

setWriteSecurity

public void setWriteSecurity(java.lang.String[] theNames)
                      throws VWException
Sets write access privileges for the current queue. Pass this method an array of strings holding the names of users and / or groups who are designated to have write access on the queue.

Limitation: this method does not validate user or group information. User and group validation occurs after the information is transferred to the VWService.

Parameters:
theNames - A string containing an array of names and / or groups who are being granted write access.
Throws:
VWException - Thrown if it cannot set write access privileges for the queue.

getDescription

public java.lang.String getDescription()
Gets the description associated with the queue definition.
Specified by:
getDescription in interface IVWTableDefinition
Overrides:
getDescription in class filenet.vw.api.VWTableDefinition
Returns:
The description for the queue definition.

setDescription

public void setDescription(java.lang.String theDescription)
Sets the description for this queue definition.
Specified by:
setDescription in interface IVWTableDefinition
Overrides:
setDescription in class filenet.vw.api.VWTableDefinition
Parameters:
theDescription - The new description for the queue definition.

toString

public java.lang.String toString()
Gets the string version of the queue definition.
Specified by:
toString in interface IVWTableDefinition
Overrides:
toString in class filenet.vw.api.VWTableDefinition
Returns:
A representation of the queue definition.

optionalSystemFields

public static VWExposedFieldDefinition[] optionalSystemFields()
                                                       throws VWException
Gets definitions of optional exposed queue fields.
Returns:
An array of VWExposedFieldDefinition objects that represent the exposed field definitions of optional workflow system fields.
Throws:
VWException - Thrown if it cannot get the exposed fields for the queue which have been marked as optional.

getLocalizedString

public static java.lang.String getLocalizedString(int theQueueType)
                                           throws VWException
Gets a localized string representation of the queue type.
Parameters:
theQueueType - An integer value associated the queue type.
Returns:
The localized version of the queue type.
Throws:
VWException - Thrown if the queue type value specified in the theQueueType parameter is invalid.

isValid

public static boolean isValid(int theQueueType)
Validates the queue type a valid type.
Parameters:
theQueueType - The integer value associated with the queue type value to be validated.
Returns:
A boolean value. This method returns true if the queue type value specified in the theQueueType parameter is valid; otherwise, this method returns false.

hasFieldName

public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
Determines whether or not the specified queue exposed field exists.
Overrides:
hasFieldName in class filenet.vw.api.VWTableDefinition
Parameters:
fieldName - The name of the field for the search.
Returns:
A boolean value. This method returns true if the data field name specified in the fieldName parameter exists; otherwise, this method returns false.
Throws:
VWException - Thrown if the field name specified in the fieldName parameter is null.

clone

public java.lang.Object clone()
Creates a clone of this VWQueueDefinition object.
Overrides:
clone in class filenet.vw.api.VWTableDefinition
Returns:
a clone of this instance.

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Returns:
A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
See Also:
setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributes)
                      throws VWException
Sets a VWAttribute object containing attributes for this object.
Parameters:
theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException -  
See Also:
getAttributeInfo()

optionalSystemFields

public static VWExposedFieldDefinition[] optionalSystemFields(int theType)
                                                       throws VWException
Get optional exposed workflow system fields for one among: roster, queue, or log. These system fields are not required, but some may be recommended.
Parameters:
theType - Type of collection on which the optional system field is exposed, as follows:
    IVWCommandServer.QUERYTYPE_LOG
    IVWCommandServer.QUERYTYPE_QUEUE
    IVWCommandServer.QUERYTYPE_ROSTER
Returns:
Exposed field definitions of optional workflow system fields

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.