|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWTableDefinition
filenet.vw.api.VWQueueDefinition
public final class VWQueueDefinition
Use this class to administer queue definitions.
To create and transfer queues, use the VWSystemConfiguration methods.
Users can define exposed fields and indexes for two types of queues in document-centric workflows: 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
. When you create
a new queue definition in a VWSystemConfiguration object, the queue
does not exist on the server until you commit the
system configuration object to the workflow server
using VWSystemConfiguration.commit
.
This class contains the following access control methods that use VWParticipant objects:
After the above methods have been used to set access permissions (using VWParticipant object arrays),the following methods should be used to get the VWParticipant arrays that represent users and groups who have Create, Read, or Write access:
getReadSecurityPx()
getWriteSecurityPx()
Note: VWParticipant objects are useful for representing user and group lists in a multiplatform environment. If VWParticipant objects are not needed, String arrays of user and group names can be used for users and groups. You can set access permissions using String arrays with the following methods:
After the above methods have been used to set access permissions (using String arrays), the following methods should be used to get the String arrays for the users and groups who have Create, Read, or Write access:
getReadSecurity()
getWriteSecurity()
VWSession
,
VWParticipant
,
VWSystemConfiguration
,
Serialized FormField Summary | |
---|---|
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. |
Fields inherited from class filenet.vw.api.VWTableDefinition |
---|
CONFIG_TYPE_LOG, CONFIG_TYPE_QUEUE, CONFIG_TYPE_ROSTER, LVALUE, RVALUE |
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 VWQueueDefinition object. |
VWWorkBasketDefinition |
createCopyOfWorkBasketDefinition(java.lang.String workBasketName,
VWWorkBasketDefinition origWorkBasketDef)
Creates a new work basket definition using the data from the specified workbasket definition. |
VWExposedFieldDefinition |
createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field in the queue, based on the specified field name and type. |
void |
createFieldDefinitions(VWExposedFieldDefinition[] theDefs)
Creates all of the exposed field definitions for this queue. |
VWIndexDefinition |
createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for this queue. |
void |
createIndexDefinitions(VWIndexDefinition[] theDefs)
Creates all of the index definitions for this queue. |
VWOperationDefinition |
createOperation(java.lang.String theName)
Creates an operation definition in this queue. |
VWWorkBasketDefinition |
createWorkBasketDefinition(java.lang.String workBasketName)
Creates a new workbasket definition. |
void |
deleteFieldDefinition(java.lang.String theName)
Removes the specified exposed field from this queue. |
void |
deleteIndexDefinition(java.lang.String theName)
Removes the specified index from this queue. |
void |
deleteOperation(java.lang.String theName)
Removes the specified operation from this queue. |
VWWorkBasketDefinition |
deleteWorkBasketDefinition(java.lang.String workBasketName)
Removes the specified workbasket. |
VWAttributeInfo |
getAttributeInfo()
Gets the attributes for this instance, as paired labels (keywords) and values. |
java.lang.String |
getDescription()
Gets the description associated with this queue definition. |
VWExposedFieldDefinition |
getField(java.lang.String name)
Returns the specified exposed field definition for the queue definition. |
VWIndexDefinition |
getIndex(java.lang.String name)
Gets the index definition specified for this queue definition. |
boolean |
getIsConnectorQueue()
Indicates whether 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 this queue. |
VWOperationDefinition |
getOperation(java.lang.String theName)
Gets the definition of an operation existing in this queue. |
VWOperationDefinition[] |
getOperations()
Gets all of the operation definitions existing in this queue. |
int |
getQueueType()
Gets the queue type of this queue definition. |
java.lang.String[] |
getReadSecurity()
Gets the names of the users and/or groups having Read access to this queue. |
VWParticipant[] |
getReadSecurityPx()
Gets the VWParticipant objects for the users and/or groups having Write access to this queue. |
int |
getServerId()
Gets the server ID of this queue definition. |
VWWorkBasketDefinition |
getWorkBasketDefinition(java.lang.String workBasketName)
Gets the specified workbasket definition for this queue. |
VWWorkBasketDefinition[] |
getWorkBasketDefinitions()
Gets all of the workbasket definitions for this queue. |
java.lang.String[] |
getWriteSecurity()
Gets the names of the users and/or groups having Write access to this queue. |
VWParticipant[] |
getWriteSecurityPx()
Gets the VWParticipant objects for the users and/or groups having Write access to this queue. |
boolean |
hasFieldName(java.lang.String fieldName)
Indicates whether the specified exposed field exists for this instance. |
static boolean |
isValid(int theQueueType)
Validates the queue type a valid type. |
static VWExposedFieldDefinition[] |
optionalSystemFields()
Gets definitions of optional exposed queue fields. |
void |
setAttributeInfo(VWAttributeInfo theAttributes)
Sets the attributes for this instance. |
void |
setDescription(java.lang.String theDescription)
Sets the description for this queue definition. |
void |
setIsConnectorQueue(boolean isConnectorQueue)
Determines whether this queue is a connector. |
void |
setReadSecurity(java.lang.String[] theNames)
Sets Read access to the current queue for the users and/or groups specified in the String array. |
void |
setReadSecurityPx(VWParticipant[] thePxList)
Sets Read access to the current queue for the users and/or groups referenced by the VWParticipant objects specified. |
void |
setServerId(int theNewServerId)
Sets the server ID for the queue. |
void |
setWriteSecurity(java.lang.String[] theNames)
Sets Write access to the current queue for the users and/or groups specified in the String array. |
void |
setWriteSecurityPx(VWParticipant[] thePxList)
Sets Write access to the current queue for the users and/or groups referenced by the VWParticipant objects specified. |
java.lang.String |
toString()
Gets the string version of the queue definition. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
Methods inherited from class filenet.vw.api.VWTableDefinition |
---|
getFields, getIndexes, optionalSystemFields |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface filenet.vw.api.IVWTableDefinition |
---|
getFields, getIndexes |
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()
,
Constant Field ValuesMethod 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
When creating the name for the new exposed field, the name must:
createFieldDefinition
in interface IVWTableDefinition
createFieldDefinition
in class VWTableDefinition
theName
- A String containing the name of the exposed field to create.theType
- An integer value indicating the data type
(arrays of types are not allowed):
theLength
- An integer value specifying the length
(in bytes) of string data stored in the field. Specify zero (0)
if the data field type is not of type String.
VWException
- Thrown if the VWExposedFieldDefinition object cannot be returned.public void deleteFieldDefinition(java.lang.String theName) throws VWException
deleteFieldDefinition
in interface IVWTableDefinition
deleteFieldDefinition
in class VWTableDefinition
theName
- A String containing the name of the exposed field being deleted from the queue.
VWException
- Thrown if the field name specified cannot be found.public void createFieldDefinitions(VWExposedFieldDefinition[] theDefs) throws VWException
This is a helper function for the JNI operations to easily add the field definitions.
theDefs
- An array of VWExposedFieldDefinition objects for the field definitions to
create in this queue.
VWException
public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
Specify the index name and an array of system fields and/or user-defined exposed fields to create the definition of the concatenated index. Use at least one field name to create the index.
The index name must:
createIndexDefinition
in interface IVWTableDefinition
createIndexDefinition
in class VWTableDefinition
theName
- A String containing the name to assign to the index.theFieldNames
- A String array of system fields and/or user-defined exposed fields.
VWException
- Thrown if the specified index name is invalid, or if
the specified fields are undefined.public void deleteIndexDefinition(java.lang.String theName) throws VWException
deleteIndexDefinition
in interface IVWTableDefinition
deleteIndexDefinition
in class VWTableDefinition
theName
- A String containing the name of the index being deleted from the queue.
VWException
- Thrown if the index specified cannot be found.public void createIndexDefinitions(VWIndexDefinition[] theDefs) throws VWException
This is a helper function for the JNI operations to easily add the index definitions.
theDefs
- An array of VWIndexDefinition objects for the indexes to create in this queue.
VWException
public VWExposedFieldDefinition getField(java.lang.String name) throws VWException
name
- the field name
VWException
public VWOperationDefinition[] getOperations() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
- Thrown if the array contains invalid elements.VWOperationDefinition
public VWOperationDefinition getOperation(java.lang.String theName) throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
theName
- A String containing the operation name.
VWException
- Thrown if the operation specified cannot be found.VWOperationDefinition
public void deleteOperation(java.lang.String theName) throws VWException
theName
- A String containing the name of the operation to be deleted from the queue.
VWException
- Thrown if the operation specified cannot be found.public VWOperationDefinition createOperation(java.lang.String theName) throws VWException
theName
- The name of the operation being created.
VWException
- Thrown if an operation definition cannot be created in this queue.VWOperationDefinition
public VWWorkBasketDefinition getWorkBasketDefinition(java.lang.String workBasketName) throws VWException
workBasketName
- A String containing the name of the workbasket.
VWException
public VWWorkBasketDefinition[] getWorkBasketDefinitions() throws VWException
VWException
public VWWorkBasketDefinition createWorkBasketDefinition(java.lang.String workBasketName) throws VWException
workBasketName
- A String containing the name to use for the workbasket definition.
VWException
- Thrown if a workbasket definition having the specified name already exists.public VWWorkBasketDefinition deleteWorkBasketDefinition(java.lang.String workBasketName) throws VWException
workBasketName
- A String containing the name of the work basket to be deleted.
VWException
- Thrown if the specified work basket name is null or invalid.VWWorkBasketDefinition
public VWWorkBasketDefinition createCopyOfWorkBasketDefinition(java.lang.String workBasketName, VWWorkBasketDefinition origWorkBasketDef) throws VWException
workBasketName
- A String containing the name to use for the workbasket definition.origWorkBasketDef
- A VWWorkBasketDefinition object for the workbasket definition
to copy.
VWException
- Thrown if a work basket definition having the specified name
already exists.public VWIndexDefinition getIndex(java.lang.String name) throws VWException
name
- the index name
VWException
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
getName
in interface IVWTableDefinition
getName
in class VWTableDefinition
public int getQueueType()
public java.lang.String[] getReadSecurity()
Note: Use this method in conjunction with setReadSecurity(); do not use this method with setReadSecurityPx().
For more information see Managing User Lists and Different Types of Security.
getReadSecurity
in class VWTableDefinition
VWException
public VWParticipant[] getReadSecurityPx() throws VWException
Note: Use this method in conjunction with setWriteSecurityPx(); do not use this method with setWriteSecurity().
For more information see Managing User Lists and Different Types of Security.
getReadSecurityPx
in class VWTableDefinition
VWException
public void setReadSecurity(java.lang.String[] theNames) throws VWException
No validation is performed, but user and group
information can be validated subsequently using the
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getReadSecurity(); do not use this method with getReadSecurityPx().
For more information see Managing User Lists and Different Types of Security.
theNames
- A String array containing the names of the users and/or
groups who are being granted Read access.
VWException
public void setReadSecurityPx(VWParticipant[] thePxList) throws VWException
No validation is performed, but user and group
information can be validated subsequently using the
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getReadSecurityPx(); do not use this method with getReadSecurity().
For more information see Managing User Lists and Different Types of Security.
thePxList
- An array of VWParticipant objects for the users and/or
groups who are being granted Write access.
VWException
public int getServerId()
getServerId
in class VWTableDefinition
public void setServerId(int theNewServerId) throws VWException
setServerId
in class 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()
Note: Use this method in conjunction with setWriteSecurity(); do not use this method with setWriteSecurityPx().
For more information see Managing User Lists and Different Types of Security.
getWriteSecurity
in class VWTableDefinition
VWException
public VWParticipant[] getWriteSecurityPx() throws VWException
Note: Use this method in conjunction with setWriteSecurityPx(); do not use this method with setWriteSecurity().
For more information see Managing User Lists and Different Types of Security.
getWriteSecurityPx
in class VWTableDefinition
VWException
public void setWriteSecurity(java.lang.String[] theNames) throws VWException
No validation is performed, but user and group
information can be validated subsequently using the
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getWriteSecurity(); do not use this method with getWreateSecurityPx().
For more information see Managing User Lists and Different Types of Security.
theNames
- A String array containing the names of the users and/or
groups who are being granted Write access.
VWException
- Thrown if Write access permissions cannot be set for the queue.public void setWriteSecurityPx(VWParticipant[] thePxList) throws VWException
No validation is performed, but user and group
information can be validated subsequently using the
VWSystemConfiguration.commit()
method.
Note: Use this method in conjunction with getWriteSecurityPx(); do not use this method with getWreateSecurity().
For more information see Managing User Lists and Different Types of Security.
thePxList
- An array of VWParticipant objects for the users and/or
groups who are being granted Write access.
VWException
- Thrown if Write access permissions cannot be set for the queue.public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
getDescription
in interface IVWTableDefinition
getDescription
in class VWTableDefinition
public void setDescription(java.lang.String theDescription)
setDescription
in interface IVWTableDefinition
setDescription
in class VWTableDefinition
theDescription
- A String containing the description for the queue definition.public java.lang.String toString()
toString
in interface IVWTableDefinition
toString
in class VWTableDefinition
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
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 VWTableDefinition
fieldName
- The name of the field. If a translation source exists, the
authored field name is translated.
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
- Thrown if the fieldName parameter is null.public java.lang.Object clone()
VWQueueDefinition
object.
clone
in class VWTableDefinition
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributes) throws VWException
theAttributes
- A VWAttribute object containing the
attributes for this instance, as paired labels (keywords) and
values in String format.
VWException
getAttributeInfo()
public boolean getIsConnectorQueue()
public void setIsConnectorQueue(boolean isConnectorQueue)
isConnectorQueue
- A boolean value of true indicates this queue is a connector queue; false indicates
it is not.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |