public interface IDfQueueItem extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAContentType()
Returns the content type of the routed object.
|
IDfTime |
getActualStartDate()
Returns the date on which work on the item actually started.
|
java.lang.String |
getContentType()
Returns the file format of the object assciated with a router task.
|
IDfTime |
getDateSent()
Returns the date the work item, task, or event was sent.
|
java.lang.String |
getDependencyType()
Returns the dependency type.
|
java.lang.String |
getDequeuedBy()
Returns the name of the user who dequeued the item.
|
IDfTime |
getDequeuedDate()
Returns the date on which the item was dequeued.
|
IDfTime |
getDueDate()
Returns the date on which the associated work item or task is expected to
be completed.
|
java.lang.String |
getEvent()
Returns the name of the event.
|
int |
getInstructionPage()
Returns the instruction page's page number.
|
IDfId |
getItemId()
Returns the object ID of the package or routed object.
|
java.lang.String |
getItemName()
Returns the name of the package associated with the work item or
router task.
|
java.lang.String |
getItemType()
Returns the object type of the package or routed object.
|
java.lang.String |
getMessage()
Returns the message associated with the work item, task, or event
notification.
|
java.lang.String |
getName()
Returns the name of the queue owner.
|
java.lang.String |
getNextTasksType()
Indicates which tasks in the "next tasks list" are queued when
this task is forwarded.
|
java.lang.String |
getOperations()
Returns the value in the a_operations attribute of the queue item.
|
IDfTime |
getPlanStartDate()
Returns the expected starting date of the associated router task.
|
double |
getPosition()
Returns the value in the position attribute.
|
int |
getPriority()
Returns the priority of the associated work item or task.
|
IDfId |
getRouterId()
Returns the object ID of the associated workflow or router.
|
java.lang.String |
getSentBy()
Returns the name of the user who sent the work item, task,
or event notification.
|
IDfTime |
getSignOffDate()
Returns the date on which the work item or task was signed off.
|
java.lang.String |
getSignOffUser()
Returns the name of the user who signed off the item.
|
java.lang.String |
getSourceDocbase()
Returns the repository that is the source of the queued object.
|
IDfId |
getSourceEvent()
Returns the object ID of the queued item in the source repository.
|
int |
getSourceStamp()
Returns the vstamp value of the source queue item.
|
IDfId |
getStamp()
Returns the object ID of the queue item object.
|
java.lang.String |
getSupervisorName()
Returns the name of the workflow or router supervisor.
|
java.lang.String |
getTargetDocbase()
Returns the name of the target repository.
|
java.lang.String |
getTaskName()
Returns the value in the task_name attribute.
|
java.lang.String |
getTaskNumber()
Returns the activity's sequence number if this is work item or the
task number if this is a router task.
|
java.lang.String |
getTaskState()
Returns the state of the associated work item or router task.
|
java.lang.String |
getTaskSubject()
Returns a subject for the task inbox item
|
java.lang.String |
getTaskType()
Returns the type of the activity or task associated with the queued item.
|
IDfWorkitem |
getWorkitem()
Returns the work item object associated with the queue item.
|
boolean |
isDeleteFlag()
Indicates whether the queued item has been dequeued.
|
boolean |
isReadFlag()
Indicates whether the queued item has been read by the queue's owner.
|
boolean |
isRemotePending()
Indicates whether the queued item is waiting for distribution.
|
boolean |
isSignOffRequired()
Indicates whether a sign off is required for the work item or task.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
IDfWorkitem getWorkitem() throws DfException
Queue items can represent work items generated by workflow activities, router tasks, or event notifications. If this queue item was generated by a workflow activity, this method returns the work item object.
DfException
- if the server returns an error or the corresponding object
is not a work itemjava.lang.String getName() throws DfException
The queue owner is the user to whom the queued item was sent. For work items, this is the work item's performer. For router tasks, this is the task's owner. The user may be an individual user or a group.
For event notifications, this is the user registered to receive the event or the workflow supervisor.
DfException
- if the server returns an errorIDfId getStamp() throws DfException
Every work item, task, or event notification that appears in an inbox is stored in the repository as a dmi_queue_item object.
DfException
- if the server returns an errorjava.lang.String getSentBy() throws DfException
DfException
- if the server returns an errorIDfTime getDateSent() throws DfException
The date sent is the date on which the item was put in the user's queue (inbox).
DfException
- if the server returns an errorIDfTime getDueDate() throws DfException
A workflow or router's designer can specify a due date for the activities or tasks. If the queue item represents a work item or task, you can use this method to determine the associated due date if one is defined.
DfException
- if the server returns an errorjava.lang.String getEvent() throws DfException
If the queue item represents an event notificaton, this method returns the name of the event. Otherwise, the method returns an empty string.
For more information about queuing events and how events function in a workflow, refer to Server Fundamentals.
DfException
- if the server returns an errorjava.lang.String getItemName() throws DfException
If the queue item represents a work item, this method returns the name of the package associated with that work item. Packages contain the objects on which the work is performed.
If the queue item represents a router task, this method returns the name of the object being routed.
DfException
- if the server returns an errorIDfId getItemId() throws DfException
If the queue item represents a work item, this method returns the object ID of the package associated with that work item. Packages contain the objects on which the work is performed.
If the queue item represents a router task, this method returns the object ID of the object being routed.
DfException
- if the server returns an errorjava.lang.String getItemType() throws DfException
If the queue item represents a work item, this method returns the object type of the package associated with the work item. Packages contain the objects on which the work is performed.
If the queue item represents a router task, this method returns the type of the object being routed.
DfException
- if the server returns an errorjava.lang.String getContentType() throws DfException
If the queue item represents a router task, this method returns the file format of the object being routed.
DfException
- if the server returns an errorjava.lang.String getMessage() throws DfException
The user or application queuing a work item, task, or event notification can provide a message to the recipient.
DfException
- if the server returns an errorIDfId getRouterId() throws DfException
If this queue item was generated by a workflow or router or is an event notificaton sent to a workflow supervisor, this method returns the object ID of the workflow or router.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous DocumentumTM releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorjava.lang.String getSupervisorName() throws DfException
This method is only useful if the queue item was generated by a workflow or router or if it is an event notification sent to a workflow supervisor.
For information about workflow supervisors, refer to Server Fundamentals.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorjava.lang.String getTaskNumber() throws DfException
Activities occur in a sequence in a workflow. When the server starts an activity, it assigns the activity a sequence number. This method returns the sequence number of the activity that generated the queue item.
If this queue item represents a router task, this method returns the task's number in the sequence of router tasks. Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorjava.lang.String getTaskName() throws DfException
If the queued item is a queued event, this method returns "event". If the queued item is a work item, this method returns the name of the activity that generated the work item. If the queued item is router task, this is the name of the task.
For information about queue items and their attributes, refer to the EMC Documentum Object Reference Manual. For information about how workflows use queue items, refer to Server Fundamentals.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
event
if the queue item represents a queued event or
the activity name if the queue item represents a work itemDfException
- if the server returns an errorjava.lang.String getTaskType() throws DfException
An activity's type (begin, step, or end) identifies its relative position within a workflow. Router tasks are also typed as begin, step, or end tasks.
For a complete description of the types of activities, refer to Server Fundamentals. Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorjava.lang.String getTaskState() throws DfException
For information about the runtime states of a work item, refer to Server Fundamentals. Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
dormant acquired paused finished
For event notifications, this returns an empty string.
DfException
- if the server returns an errorjava.lang.String getDependencyType() throws DfException
This method is valid only for queued router tasks. It returns the dependency type of the task.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorjava.lang.String getNextTasksType() throws DfException
This method is valid only for queued router
tasks. It returns a string that tells you which tasks defined as
following this task are selected for queuing. The possible values
are all
, meaning all next tasks are selected;
none
, meaning none of the next tasks are selected; or
decisions
, meaning the current task's performer selects
the next tasks at runtime.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
all
, none
, or decision
.
If the queued item is work item or event notification, this returns
an empty string.DfException
- if the server returns an errorint getInstructionPage() throws DfException
This method is valid only for queued router tasks. The method returns the page number of the router's content file that contains instructions for the task's owner.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorIDfTime getPlanStartDate() throws DfException
This method is valid only for queued router tasks. The router's designer can set a planned starting date for each task in the router. This method returns that date if it is defined for the task.
Routers are pre-4.0 functionality. For information about them, refer to the documentation of previous Documentum releases. For information about router support in 4.0 releases (and above), refer to the Server Migration Guide.
DfException
- if the server returns an errorIDfTime getActualStartDate() throws DfException
This value records the date on which the work item or task was acquired by its performer.
DfException
- if the server returns an errorboolean isReadFlag() throws DfException
A queue item is considered read if the queue's owner opened and viewed the queue after the item was placed on the queue. For more information about queues and their management, refer to Server Fundamentals.
true
if the queue item has been viewed or
false
if it has notDfException
- if the server returns an errorboolean isDeleteFlag() throws DfException
Dequeuing takes the work item, task, or event notification off the user's queue. The item is no longer visible in the user's inbox. For more information about dequeuing an item, refer to Server Fundamentals.
true
if the item is dequeued or false
if the item is not dequeuedDfException
- if the server returns an errorint getPriority() throws DfException
The priority is a user-defined integer value. For more information about using the priority, refer to Server Fundamentals.
DfException
- if the server returns an errordouble getPosition() throws DfException
This dmi_queue_item attribute is currently unused.
DfException
- if the server returns an errorjava.lang.String getDequeuedBy() throws DfException
Dequeuing a work item, task, or event notification removes the item from the user's inbox. For more information about dequeuing, refer to Server Fundamentals.
DfException
- if the server returns an errorIDfTime getDequeuedDate() throws DfException
Dequeuing an item removes the item from the user's inbox. For more information about dequeuing, refer to Server Fundamentals.
DfException
- if the server returns an errorboolean isSignOffRequired() throws DfException
A workflow or router's designer can require a sign off on activities or tasks. This method returns a Boolean value that indicates whether a sign off is required for the work item or task associated with this queue item.
true
if a sign off is required; false
if not. The return value is undefined if the item is an event notificationDfException
- if the server returns an errorjava.lang.String getSignOffUser() throws DfException
A workflow or router's designer can require a sign off on activities or tasks. If a sign off is required, the work item or task is not considered complete until the user performing it signs off. For more information about signing off workflow activities, refer to Server Fundamentals.
DfException
- if the server returns an errorIDfTime getSignOffDate() throws DfException
A workflow or router's designer can require a sign off on activities or tasks. If a sign off is required, the work item or task is not considered complete until the user performing it signs off. For more information about signing off workflow activities, refer to Server Fundamentals.
DfException
- if the server returns an errorjava.lang.String getAContentType() throws DfException
This method is valid only for router tasks. The method returns the value in the queue item's a_content_type attribute. The value is the name of the file format an application uses when opening the object associated with the task.
DfException
- if the server returns an errorjava.lang.String getOperations() throws DfException
If the queue item was generated by a workflow activity, this value is the operation defined for the associated package. The operation indicates which application is expected to perform the work associated with the work item.
If the queue item was generated by a router, this value is user-defined.
DfException
- if the server returns an errorjava.lang.String getSourceDocbase() throws DfException
This method only returns a value if the queued item is an
object that must be distributed to another repository. You can
obtain the name of the target repository (the repository to which the
object is sent) using getTargetDocbase()
.
DfException
- if the server returns an errorjava.lang.String getTargetDocbase() throws DfException
This method returns a value only if the queued item is a distributed object. The method returns the name of the repository to which the object is sent.
DfException
- if the server returns an errorboolean isRemotePending() throws DfException
If this method returns true
, the object associated with
the queue item is waiting to be sent to the repository defined as the
target repository. To determine the target repository, use getTargetDocbase()
.
true
if the object is waiting to be sent; false
if the item has been sent. This is an undefined value if the item is
not a distributed objectDfException
- if the server returns an errorIDfId getSourceEvent() throws DfException
If this queued item is an object that has been sent to the user from another repository, this method returns the object ID of the dmi_queue_item object in the source repository that generated this queue item.
For information about distributed workflows, refer to Server Fundamentals.
DfException
- if the server returns an errorint getSourceStamp() throws DfException
This method is only valid if the queued item is an object that has been sent to the repository from another repository.
The vstamp values are used internally to manage versioning.
DfException
- if the server returns an errorjava.lang.String getTaskSubject() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.