VWQueueStats (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWQueueStats

All Implemented Interfaces:

java.io.Serializable

Deprecated.
This class has been deprecated since BPM release 4.0. Use Case Analyzer for Workflow Statistics.
```
public final class VWQueueStats
extends java.lang.Object
```
Use this class to encapsulate the statistical results for a queue. Instances of the class are created as a result of a request to the log manager to get a copy of the queue statistics. The instance of the class is used to retrieve the performance statistics on a queue.

Since:

VWWS3.10

See Also:

VWRosterStats, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Double`	`getAverageProcessedWO()` Deprecated. Gets the ratio of the summation of sample counts of the processed work objects to the number of samples.
`java.lang.Double`	`getAverageQueueDelay()` Deprecated. Gets the ratio of the total of the time periods (in the requested time units) work objects stayed in a queue, to the number of work objects dequeued during the evaluation period.
`java.lang.Double`	`getAverageQueueDepth()` Deprecated. Gets the ratio of the summation of queue depths, summed over the sample periods, to the number of samples.
`java.lang.Double`	`getAverageThroughput()` Deprecated. Gets the ratio of the number of work objects dequeued to the number of time units spanning the evaluation period.
`java.lang.Double`	`getAverageWOLocked()` Deprecated. Gets a ratio of the summation of the sample counts of the locked work objects to the number of samples as a ratio.
`java.lang.Double`	`getAverageWOProcessingTime()` Deprecated. Gets the per-time-unit average processing time for a work object.
`java.lang.String`	`getClassName()` Deprecated. Provides the name of the class (Queue or Roster) whose statistics are to be retrieved.
`java.lang.Double`	`getCurrentQueueDepth()` Deprecated. Gets a number representing the queue depth at a sample point, at the time the method is processed.
`java.lang.Double`	`getCurrentWOLocked()` Deprecated. Gets a double-precision number that is the count of the number of work objects locked at the sample point.
`java.lang.Double`	`getDequeuedRate()` Deprecated. Gets the ratio of the dequeued work objects to the number of time units in the evaluation period.
`java.util.Date`	`getEndTime()` Deprecated. Gets the time the evaluated request completed on the server.
`java.util.Date`	`getEvaluationTime()` Deprecated. Gets the time stamp for the time this request was evaluated on the server.
`java.lang.Double`	`getInitialNumberOfQueued()` Deprecated. Gets the initial number of work objects in the queue at the beginning of the time evaluation period.
`java.lang.Double`	`getNumberOfRemainingQueued()` Deprecated. Gets the final number of work objects in the queue.
`java.lang.Double`	`getNumberOfSamples()` Deprecated. Gets a number that indicates the number of samples taken within the evaluation period.
`java.lang.Double`	`getNumberOfUnitsInPeriod()` Deprecated. Gets a count that indicates the number of time units in the evaluation period.
`java.lang.Double`	`getNumberOfWOLocked()` Deprecated. Gets the number of work objects locked during the evaluation period.
`java.lang.Double`	`getNumberOfWOProcessed()` Deprecated. Gets the number of work objects processed during the evaluation period.
`java.lang.Double`	`getQueuedRate()` Deprecated. Gets the ratio of the number of work objects queued to the number of time units in the evaluation period.
`java.lang.Double`	`getQueueGrowthRate()` Deprecated. Gets the ratio of the queued work objects to the dequeued work objects over the evaluation period.
`java.lang.String`	`getQueueName()` Deprecated. Gets the name of the queue for the statistics object.
`java.util.Date`	`getRequestedEndTime()` Deprecated. Gets the time value the user specified as the end time for the queue statistics evaluation.
`java.util.Date`	`getRequestedStartTime()` Deprecated. Gets the time value the user specified as the start time for the queue statistics evaluation.
`int`	`getRequestedTimeUnit()` Deprecated. Gets the evaluation period unit of measure (or interval) specified by the user (for example, minutes, hours, days, etc.).
`java.util.Date`	`getStartTime()` Deprecated. Gets the time the evaluated request began on the server.
`java.lang.Double`	`getSummationDurationWOInQueue()` Deprecated. Gets the summation of the durations of work objects in the queue, summed over the samples in the evaluation period.
`java.lang.Double`	`getSummationQueueDepth()` Deprecated. Gets a number representing the sum of all queue depths for the samples in the evaluation period.
`java.lang.Double`	`getSummationWOLocked()` Deprecated. Gets a number representing the summation of the counts of all work objects locked in the queue for each sample, summed over the samples in the evaluation period.
`java.lang.Double`	`getSummationWOProcessed()` Deprecated. Gets a number representing the sum of the counts of all work objects that have been advanced or updated for the samples in the evaluation period.
`java.lang.Double`	`getTotalAbortedTime()` Deprecated. Gets a double-precision number indicating the total queue time (in the requested work units) taken by work objects that were unlocked and never processed.
`java.lang.Double`	`getTotalServiceTime()` Deprecated. Gets a double-precision number indicating the total queue time (in the requested work units) taken by locked work objects until they are advanced or updated.
`java.lang.Double`	`getTotalWOAborted()` Deprecated. Gets a number indicating the total number of the work objects that are locked and then unlocked without processing since the beginning of the time interval.
`java.lang.Double`	`getTotalWODequeued()` Deprecated. Gets a number that indicates the count of all of the work objects dequeued since the beginning of the time interval.
`java.lang.Double`	`getTotalWOQueued()` Deprecated. Gets a double-precision number that is the count of all work objects queued during the evaluation period.
`java.lang.String`	`toString()` Deprecated. Gets the queue name and the start and end times of the statistics in a string format.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getEvaluationTime
```
public java.util.Date getEvaluationTime()
```
    Deprecated.
    
    Gets the time stamp for the time this request was evaluated on the server. The stamp is made at the time of response.
    
    Returns:
    
    A time value indicating the time that the queue statistics request was evaluated on the Process Engine.
  - getStartTime
```
public java.util.Date getStartTime()
```
    Deprecated.
    
    Gets the time the evaluated request began on the server. The start time and end time, which can be requested with getEndTime(), may be different than the times requested by the caller; these time values are based on the actual snapshot stored on the database.
    
    Returns:
    
    A time value indicating the time the request began.
    
    See Also:
    
    VWQueueStats.getEndTime(), VWQueueStats.getRequestedEndTime()
  - getEndTime
```
public java.util.Date getEndTime()
```
    Deprecated.
    
    Gets the time the evaluated request completed on the server. The end time and start time, which can be requested getStartTime(), may be different than the times requested by the caller; these time values are based on the actual snapshot stored on the database.
    
    Returns:
    
    A time value indicating the time the request completed.
    
    See Also:
    
    VWQueueStats.getStartTime(), VWQueueStats.getRequestedStartTime()
  - getRequestedStartTime
```
public java.util.Date getRequestedStartTime()
```
    Deprecated.
    
    Gets the time value the user specified as the start time for the queue statistics evaluation.
    
    Returns:
    
    A time value indicating the start time requested by a user.
  - getRequestedEndTime
```
public java.util.Date getRequestedEndTime()
```
    Deprecated.
    
    Gets the time value the user specified as the end time for the queue statistics evaluation.
    
    Returns:
    
    A time value indicating the end time requested by a user.
  - getRequestedTimeUnit
```
public int getRequestedTimeUnit()
```
    Deprecated.
    
    Gets the evaluation period unit of measure (or interval) specified by the user (for example, minutes, hours, days, etc.).
    Returns:
    An integer value indicating the unit of measurement for the time value. Valid integer values are:
    
    1: Minutes
    2: Hours
    3: Days
    4: Weeks
    5: Months
    6: Years
    See Also:
    
    VWTimeUnitType
  - getNumberOfUnitsInPeriod
```
public java.lang.Double getNumberOfUnitsInPeriod()
```
    Deprecated.
    
    Gets a count that indicates the number of time units in the evaluation period. The time units are the unit of measurement specified by the user.
    
    Returns:
    
    A number value indicating the units that are adjusted by the specified unit of time (or interval).
    
    See Also:
    
    VWQueueStats.getRequestedTimeUnit()
  - getNumberOfSamples
```
public java.lang.Double getNumberOfSamples()
```
    Deprecated.
    
    Gets a number that indicates the number of samples taken within the evaluation period.
    
    Returns:
    
    An integer value indicating the total number of samples taken during the evaluation period.
  - getQueueName
```
public java.lang.String getQueueName()
```
    Deprecated.
    
    Gets the name of the queue for the statistics object. If a translation source exists, the authored name is translated.
    
    Returns:
    
    A String containing the translated name of the queue being sampled for statistical information, if a translation source exists; otherwise the authored information is returned.
  - getInitialNumberOfQueued
```
public java.lang.Double getInitialNumberOfQueued()
```
    Deprecated.
    
    Gets the initial number of work objects in the queue at the beginning of the time evaluation period.
    
    Returns:
    
    An integer value that indicates the initial number of queued work objects when the requested evaluation began.
  - getNumberOfRemainingQueued
```
public java.lang.Double getNumberOfRemainingQueued()
```
    Deprecated.
    
    Gets the final number of work objects in the queue.
    
    Returns:
    
    A double precision number that indicates the number of remaining queued work objects at the time the requested evaluation completed.
  - getNumberOfWOProcessed
```
public java.lang.Double getNumberOfWOProcessed()
```
    Deprecated.
    
    Gets the number of work objects processed during the evaluation period.
    
    Returns:
    
    The number of work objects processed during the evaluation period.
  - getNumberOfWOLocked
```
public java.lang.Double getNumberOfWOLocked()
```
    Deprecated.
    
    Gets the number of work objects locked during the evaluation period.
    
    Returns:
    
    The number of work objects locked during the evaluation period.
  - getAverageWOProcessingTime
```
public java.lang.Double getAverageWOProcessingTime()
```
    Deprecated.
    
    Gets the per-time-unit average processing time for a work object.
    
    Returns:
    
    A number indicating the average time to process a work object during the evaluation period.
    
    See Also:
    
    VWQueueStats.getRequestedTimeUnit(), VWQueueStats.getNumberOfWOProcessed()
  - getAverageThroughput
```
public java.lang.Double getAverageThroughput()
```
    Deprecated.
    
    Gets the ratio of the number of work objects dequeued to the number of time units spanning the evaluation period.
    
    Returns:
    
    A number indicating the per-time-unit average work object throughput.
    
    See Also:
    
    VWQueueStats.getRequestedTimeUnit(), VWQueueStats.getTotalWODequeued()
  - getAverageQueueDelay
```
public java.lang.Double getAverageQueueDelay()
```
    Deprecated.
    
    Gets the ratio of the total of the time periods (in the requested time units) work objects stayed in a queue, to the number of work objects dequeued during the evaluation period.
    
    Returns:
    
    A ratio indicating average work object delay.
    
    See Also:
    
    VWQueueStats.getSummationDurationWOInQueue(), VWQueueStats.getTotalWODequeued(), VWQueueStats.getRequestedTimeUnit()
  - getTotalWODequeued
```
public java.lang.Double getTotalWODequeued()
```
    Deprecated.
    
    Gets a number that indicates the count of all of the work objects dequeued since the beginning of the time interval. Each dequeue operation increments the count, even when a given work object is queued and dequeued multiple times.
    
    Returns:
    
    A number indicating the total number of work objects dequeued during the evaluation period.
  - getTotalWOQueued
```
public java.lang.Double getTotalWOQueued()
```
    Deprecated.
    
    Gets a double-precision number that is the count of all work objects queued during the evaluation period. If the same work object is enqueued multiple times, each enqueue operation increments the count.
    
    Returns:
    
    A number indicating the total count of work objects enqueued during the evaluation period.
  - getTotalWOAborted
```
public java.lang.Double getTotalWOAborted()
```
    Deprecated.
    
    Gets a number indicating the total number of the work objects that are locked and then unlocked without processing since the beginning of the time interval. The number increments by one each time a work object is unlocked without advance or update.
    
    Returns:
    
    A number indicating the total number of work objects unlocked without an accompanying advance or update.
  - getTotalServiceTime
```
public java.lang.Double getTotalServiceTime()
```
    Deprecated.
    
    Gets a double-precision number indicating the total queue time (in the requested work units) taken by locked work objects until they are advanced or updated.
    
    Returns:
    
    A number indicating the time taken for locked work objects to be advanced or updated.
  - getTotalAbortedTime
```
public java.lang.Double getTotalAbortedTime()
```
    Deprecated.
    
    Gets a double-precision number indicating the total queue time (in the requested work units) taken by work objects that were unlocked and never processed.
    
    Returns:
    
    A number indicating the time taken to unlock work objects that did not have an accompanying processing request.
  - getDequeuedRate
```
public java.lang.Double getDequeuedRate()
```
    Deprecated.
    
    Gets the ratio of the dequeued work objects to the number of time units in the evaluation period.
    
    Returns:
    
    A number expressing the per-time-unit rate of dequeue operations.
    
    See Also:
    
    VWQueueStats.getTotalWODequeued()
  - getQueuedRate
```
public java.lang.Double getQueuedRate()
```
    Deprecated.
    
    Gets the ratio of the number of work objects queued to the number of time units in the evaluation period.
    
    Returns:
    
    A number expressing the per-time-unit rate of queueing.
    
    See Also:
    
    VWQueueStats.getTotalWOQueued()
  - getSummationDurationWOInQueue
```
public java.lang.Double getSummationDurationWOInQueue()
```
    Deprecated.
    
    Gets the summation of the durations of work objects in the queue, summed over the samples in the evaluation period. Duration times for work objects that remain in the queue at the end of the evaluation period are counted.
    
    Returns:
    
    A number indicating the summation of the durations of work objects in the queue, summed over the samples in the evaluation period.
  - getQueueGrowthRate
```
public java.lang.Double getQueueGrowthRate()
```
    Deprecated.
    
    Gets the ratio of the queued work objects to the dequeued work objects over the evaluation period.
    
    Returns:
    
    A number expressing the ratio between the queued work objects and the dequeued work objects over the evaluation period.
    
    See Also:
    
    VWQueueStats.getTotalWOQueued(), VWQueueStats.getTotalWODequeued()
  - getAverageQueueDepth
```
public java.lang.Double getAverageQueueDepth()
```
    Deprecated.
    
    Gets the ratio of the summation of queue depths, summed over the sample periods, to the number of samples.
    
    Returns:
    
    The average queue depth for a sample period.
    
    See Also:
    
    VWQueueStats.getSummationQueueDepth()
  - getAverageProcessedWO
```
public java.lang.Double getAverageProcessedWO()
```
    Deprecated.
    
    Gets the ratio of the summation of sample counts of the processed work objects to the number of samples.
    
    Returns:
    
    A number expressing the ratio of the summation of sample counts of the processed work objects, to the number of samples.
    
    See Also:
    
    VWQueueStats.getNumberOfWOProcessed()
  - getAverageWOLocked
```
public java.lang.Double getAverageWOLocked()
```
    Deprecated.
    
    Gets a ratio of the summation of the sample counts of the locked work objects to the number of samples as a ratio.
    
    Returns:
    
    A number expressing the average number of work objects locked in a sample over the evaluation period.
    
    See Also:
    
    VWQueueStats.getSummationWOLocked()
  - getSummationQueueDepth
```
public java.lang.Double getSummationQueueDepth()
```
    Deprecated.
    
    Gets a number representing the sum of all queue depths for the samples in the evaluation period. Divide the returned number by the number of samples to calculate the average queue depth.
    
    Returns:
    
    The summation queue depth, summed over the samples comprising the evaluation period.
    
    See Also:
    
    VWQueueStats.getAverageQueueDepth()
  - getSummationWOProcessed
```
public java.lang.Double getSummationWOProcessed()
```
    Deprecated.
    
    Gets a number representing the sum of the counts of all work objects that have been advanced or updated for the samples in the evaluation period.
    
    Returns:
    
    A number indicating the sum of the counts of all processed work objects, summed over the samples in the evaluation period.
    
    See Also:
    
    VWQueueStats.getAverageProcessedWO()
  - getSummationWOLocked
```
public java.lang.Double getSummationWOLocked()
```
    Deprecated.
    
    Gets a number representing the summation of the counts of all work objects locked in the queue for each sample, summed over the samples in the evaluation period.
    
    Returns:
    
    A number indicating the sum of all counts of work objects locked in each sample.
    
    See Also:
    
    VWQueueStats.getAverageWOLocked()
  - getCurrentQueueDepth
```
public java.lang.Double getCurrentQueueDepth()
```
    Deprecated.
    
    Gets a number representing the queue depth at a sample point, at the time the method is processed. Note that the returned number is independent of the evaluation time interval, from start time to end time.
    
    Returns:
    
    A number indicating the current total count of queued work objects.
  - getCurrentWOLocked
```
public java.lang.Double getCurrentWOLocked()
```
    Deprecated.
    
    Gets a double-precision number that is the count of the number of work objects locked at the sample point. Note that the returned number is independent of the time interval, from start time to end time.
    
    Returns:
    
    A number indicating the current count of the work objects locked.
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Gets the queue name and the start and end times of the statistics in a string format. The format is as follows:
    <QueueName> from <StartTime> to <EndTime>
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string value containing the name of the Queue, the start time, and the end time of the fundamental statistics specification.
  - getClassName
```
public java.lang.String getClassName()
```
    Deprecated.
    
    Provides the name of the class (Queue or Roster) whose statistics are to be retrieved.
    
    Returns:
    
    The name of the class (Queue or Roster)

Methods inherited from class java.lang.Object

getEvaluationTime

getStartTime

getEndTime

getRequestedStartTime

getRequestedEndTime

getRequestedTimeUnit

getNumberOfUnitsInPeriod

getNumberOfSamples

getQueueName

getInitialNumberOfQueued

getNumberOfRemainingQueued

getNumberOfWOProcessed

getNumberOfWOLocked

getAverageWOProcessingTime

getAverageThroughput

getAverageQueueDelay

getTotalWODequeued

getTotalWOQueued

getTotalWOAborted

getTotalServiceTime

getTotalAbortedTime

getDequeuedRate

getQueuedRate

getSummationDurationWOInQueue

getQueueGrowthRate

getAverageQueueDepth

getAverageProcessedWO

getAverageWOLocked

getSummationQueueDepth

getSummationWOProcessed

getSummationWOLocked

getCurrentQueueDepth

getCurrentWOLocked

toString

getClassName