filenet.vw.api

Class VWQueueDefinition

    • Field Detail

      • QUEUE_TYPE_PROCESS

        public static final int QUEUE_TYPE_PROCESS
        Value of 1. This field value indicates a process queue type. A process queue holds objects processed by external workflow applications.
        See Also:
        Constant Field Values

      • QUEUE_TYPE_USER_CENTRIC

        public static final int QUEUE_TYPE_USER_CENTRIC
        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.
        See Also:
        Constant Field Values

      • QUEUE_TYPE_SYSTEM

        public static final int QUEUE_TYPE_SYSTEM
        Value of 3. This field value indicates a System queue type. System queues are configured by the system.
        See Also:
        Constant Field Values

      • QUEUE_ON_ALL_SERVERS

        public static final int QUEUE_ON_ALL_SERVERS
        Signed integer value of -1. This is not a queue type, rather, this value indicates the queue is located on all servers. User-centric queues, for example, are on all servers.
        See Also:
        VWQueueDefinition.getQueueType(), Constant Field Values

    • Method Detail

      • createFieldDefinition

        public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName,
                                                      int theType,
                                                      int theLength)
                                               throws VWException
        Creates an exposed field in the queue, based on the specified field name and type. Use exposed fields to create index definitions.

        When creating the name for the new exposed field, the name must:

        • Begin with an alphabetic character.
        • Start with characters other than "F_". An underscore is acceptable after initial letters other than "F".
        • Use only alphanumeric characters
        Specified by:
        createFieldDefinition in interface IVWTableDefinition
        Overrides:
        createFieldDefinition in class VWTableDefinition
        Parameters:
        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):

        • 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 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.
        Returns:
        The VWExposedFieldDefinition object for the new exposed field definition for the queue.
        Throws:
        VWException - Thrown if the VWExposedFieldDefinition object cannot be returned.

      • createFieldDefinitions

        public void createFieldDefinitions(VWExposedFieldDefinition[] theDefs)
                            throws VWException
        Creates all of the exposed field definitions for this queue.

        This is a helper function for the JNI operations to easily add the field definitions.

        Parameters:
        theDefs - An array of VWExposedFieldDefinition objects for the field definitions to create in this queue.
        Throws:
        VWException

      • createIndexDefinition

        public VWIndexDefinition createIndexDefinition(java.lang.String theName,
                                               java.lang.String[] theFieldNames)
                                        throws VWException
        Creates an index definition for this queue.

        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:

        • Start with characters other than "F_". An underscore is acceptable after initial letters other than "F".
        • Use only alphanumeric characters
        Specified by:
        createIndexDefinition in interface IVWTableDefinition
        Specified by:
        createIndexDefinition in class VWTableDefinition
        Parameters:
        theName - A String containing the name to assign to the index.
        theFieldNames - A String array of system fields and/or user-defined exposed fields.
        Returns:
        A VWIndexDefinition object for the index definition created.
        Throws:
        VWException - Thrown if the specified index name is invalid, or if the specified fields are undefined.

      • createIndexDefinitions

        public void createIndexDefinitions(VWIndexDefinition[] theDefs)
                            throws VWException
        Creates all of the index definitions for this queue.

        This is a helper function for the JNI operations to easily add the index definitions.

        Parameters:
        theDefs - An array of VWIndexDefinition objects for the indexes to create in this queue.
        Throws:
        VWException

      • getField

        public VWExposedFieldDefinition getField(java.lang.String name)
                                  throws VWException
        Returns the specified exposed field definition.

        If a translation source exists, the authored field information is translated.

        Parameters:
        name - A String containing the field name.
        Returns:
        A VWExposedFieldDefinition object for the field information (translated, if a translation source exists). If the field cannot be found, null is returned.
        Throws:
        VWException
        Since:
        P8 4.0

      • getOperations

        public VWOperationDefinition[] getOperations()
                                      throws VWException
        Gets all of the operation definitions existing in this queue. If a translation source exists, the authored operation information 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).

        Returns:
        An array of VWOperationDefinition objects for the operations. If a translation source exists, the translated operation information is returned; otherwise, the authored information is returned. If no associated operation definitions exist, null is returned.
        Throws:
        VWException - Thrown if the array contains invalid elements.
        See Also:
        VWOperationDefinition

      • getOperation

        public VWOperationDefinition getOperation(java.lang.String theName)
                                   throws VWException
        Gets the definition of an operation existing in this queue. If a translation source exists, the authored operation information 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).

        Parameters:
        theName - A String containing the operation name.
        Returns:
        The VWOperationDefinition object for the specified operation. If a translation source exists, the translated operation information is returned; otherwise, the authored information is returned.
        Throws:
        VWException - Thrown if the operation specified cannot be found.
        See Also:
        VWOperationDefinition

      • deleteOperation

        public void deleteOperation(java.lang.String theName)
                     throws VWException
        Removes the specified operation from this queue.
        Parameters:
        theName - A String containing the name of the operation to be deleted from the queue.
        Throws:
        VWException - Thrown if the operation specified 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 for the specified operation.
        Throws:
        VWException - Thrown if an operation definition cannot be created in this queue.
        See Also:
        VWOperationDefinition

      • getWorkBasketDefinition

        public VWWorkBasketDefinition getWorkBasketDefinition(java.lang.String workBasketName)
                                               throws VWException
        Gets the specified workbasket definition for this queue.
        Parameters:
        workBasketName - A String containing the name of the workbasket.
        Returns:
        The VWWorkBasketDefinition object for the workbasket, or null if the workbasket definition is not found.
        Throws:
        VWException
        Since:
        P8 4.5.0

      • getWorkBasketDefinitions

        public VWWorkBasketDefinition[] getWorkBasketDefinitions()
                                                  throws VWException
        Gets all of the workbasket definitions for this queue.
        Returns:
        An array of VWWorkBasketDefinition objects, or null if no work baskets are found.
        Throws:
        VWException
        Since:
        P8 4.5.0

      • createWorkBasketDefinition

        public VWWorkBasketDefinition createWorkBasketDefinition(java.lang.String workBasketName)
                                                  throws VWException
        Creates a new workbasket definition.
        Parameters:
        workBasketName - A String containing the name to use for the workbasket definition.
        Returns:
        The VWWorkBasketDefinition object for the new workbasket definition.
        Throws:
        VWException - Thrown if a workbasket definition having the specified name already exists.
        Since:
        P8 4.5.0

      • deleteWorkBasketDefinition

        public VWWorkBasketDefinition deleteWorkBasketDefinition(java.lang.String workBasketName)
                                                  throws VWException
        Deletes the specified workbasket.
        Parameters:
        workBasketName - A String containing the name of the work basket to be deleted.
        Returns:
        A VWWorkBasketDefinition object for the workbasket deleted.
        Throws:
        VWException - Thrown if the specified work basket name is null or invalid.
        Since:
        P8 4.5.0
        See Also:
        VWWorkBasketDefinition

      • createCopyOfWorkBasketDefinition

        public VWWorkBasketDefinition createCopyOfWorkBasketDefinition(java.lang.String workBasketName,
                                                               VWWorkBasketDefinition origWorkBasketDef)
                                                        throws VWException
        Creates a new work basket definition using the data from the specified workbasket definition.
        Parameters:
        workBasketName - A String containing the name to use for the workbasket definition.
        origWorkBasketDef - A VWWorkBasketDefinition object for the workbasket definition to copy.
        Returns:
        The VWWorkBasketDefinition object for the new workbasket definition.
        Throws:
        VWException - Thrown if a work basket definition having the specified name already exists.
        Since:
        P8 4.5.0

      • getIndex

        public VWIndexDefinition getIndex(java.lang.String name)
                           throws VWException
        Gets the index definition specified for this queue definition.

        If a translation source exists, the authored index information is translated.

        Parameters:
        name - A String containing the index name.
        Returns:
        A VWIndexDefinition object for the index information (translated, if a translation source exists). If the index cannot be found, null is returned.
        Throws:
        VWException
        Since:
        P8 4.0

      • getName

        public java.lang.String getName()
        Gets the authored name of this queue.
        Specified by:
        getName in interface IVWTableDefinition
        Overrides:
        getName in class VWTableDefinition
        Returns:
        A String containing the authored name of this 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()
        Gets the names of the users and/or groups having Read access to this queue.

        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.

        Overrides:
        getReadSecurity in class VWTableDefinition
        Returns:
        A String array containing the names of the users and/or groups having Read access to this queue.
        Throws:
        VWException

      • setReadSecurity

        public void setReadSecurity(java.lang.String[] theNames)
                     throws VWException
        Sets Read access to the current queue for the users and/or groups specified in the String array.

        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.

        Parameters:
        theNames - A String array containing the names of the users and/or groups who are being granted Read access.
        Throws:
        VWException

      • setReadSecurityPx

        public void setReadSecurityPx(VWParticipant[] thePxList)
                       throws VWException
        Sets Read access to the current queue for the users and/or groups referenced by the VWParticipant objects specified.

        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.

        Parameters:
        thePxList - An array of VWParticipant objects for the users and/or groups who are being granted Write access.
        Throws:
        VWException

      • getServerId

        public int getServerId()
        Gets the server ID of this queue definition.
        Overrides:
        getServerId in class 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 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()
        Gets the names of the users and/or groups having Write access to this queue.

        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.

        Overrides:
        getWriteSecurity in class VWTableDefinition
        Returns:
        A String array containing the names of the users and/or groups having Write access to this queue.
        Throws:
        VWException

      • setWriteSecurity

        public void setWriteSecurity(java.lang.String[] theNames)
                      throws VWException
        Sets Write access to the current queue for the users and/or groups specified in the String array.

        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.

        Parameters:
        theNames - A String array containing the names of the users and/or groups who are being granted Write access.
        Throws:
        VWException - Thrown if Write access permissions cannot be set for the queue.

      • setWriteSecurityPx

        public void setWriteSecurityPx(VWParticipant[] thePxList)
                        throws VWException
        Sets Write access to the current queue for the users and/or groups referenced by the VWParticipant objects specified.

        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.

        Parameters:
        thePxList - An array of VWParticipant objects for the users and/or groups who are being granted Write access.
        Throws:
        VWException - Thrown if Write access permissions cannot be set for the queue.

      • getDescription

        public java.lang.String getDescription()
        Gets the description associated with this queue definition. If a translation source exists, the authored description 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).

        Specified by:
        getDescription in interface IVWTableDefinition
        Overrides:
        getDescription in class VWTableDefinition
        Returns:
        A String containing the translated description, if a translation source exists; otherwise the authored description is returned.

      • 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 VWTableDefinition
        Parameters:
        theDescription - A String containing the 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 VWTableDefinition
        Returns:
        A String representation of the queue definition.

      • toXML

        public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
        Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).
        Appends an XML string representing this instance to the buffer specified.

        Warning: This XML string is nonextensible, and cannot be modified in any way.

        Specified by:
        toXML in interface IVWtoXML
        Parameters:
        theBuffer - A StringBuffer that will be appended with the XML content.
        Throws:
        VWException - Thrown if the specified buffer is null.
        See Also:
        VWXMLConfiguration

      • hasChanged

        public boolean hasChanged()
                   throws VWException
        Returns a boolean value indicating whether or not this queue has changed.
        Returns:
        A value of true if this queue has changed; false otherwise.
        Throws:
        VWException - Thrown if an error occurs.
        Since:
        PE 4.5.0

      • optionalSystemFields

        public static VWExposedFieldDefinition[] optionalSystemFields()
                                                       throws VWException
        Gets the 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 the optional exposed fields cannot be found.

      • 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 with 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.
        Parameters:
        theQueueType - The integer value associated with the queue type value to be validated.
        Returns:
        A boolean value of true if the queue type value specified is valid; false otherwise.

      • hasFieldName

        public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
        Indicates whether the specified exposed field exists for this instance.
        Overrides:
        hasFieldName in class VWTableDefinition
        Parameters:
        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).

        Returns:
        A boolean value of true if the field name specified exists; otherwise, false.
        Throws:
        VWException - Thrown if the fieldName parameter is null.

      • clone

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

      • getIsConnectorQueue

        public boolean getIsConnectorQueue()
        Indicates whether this queue is a connector.
        Returns:
        isConnectorQueue A boolean value of true if this queue is a connector queue; false otherwise.

      • setIsConnectorQueue

        public void setIsConnectorQueue(boolean isConnectorQueue)
        Determines whether this queue is a connector.
        Parameters:
        isConnectorQueue - A boolean value of true indicates this queue is a connector queue; false indicates it is not.
Skip navigation links
Process API

© Copyright IBM Corporation 2002, 2019. All rights reserved.