Process Class Relationships

filenet.vw.api
Class VWRosterStats

java.lang.Object
  |
  +--filenet.vw.api.VWStatistics
        |
        +--filenet.vw.api.VWRosterStats
All Implemented Interfaces:
java.io.Serializable

public final class VWRosterStats
extends filenet.vw.api.VWStatistics

Use this class to retrieve roster statistics. The system generates statistics as the result of a request to the log manager to get a copy of the roster statistics.

Since:
VWWS3.10
See Also:
VWQueueStats, Serialized Form

Method Summary
 java.lang.Double getAverageLifeSpanChildWO()
          Gets the average life span of child work objects since the beginning of the time interval.
 java.lang.Double getAverageLifeSpanOfWO()
          Gets the average life span of work objects since the beginning of the time interval.
 java.lang.Double getAverageLifeSpanParentWO()
          Gets the average life span of parent work objects since the beginning of the time interval.
 java.lang.Double getAverageNumberOfActiveChildWO()
          Gets the ratio of the sum of child work objects that are alive in the system to the number of samples taken.
 java.lang.Double getAverageNumberOfActiveParentWO()
          Gets the ratio of the sum of parent work objects that are alive in the system to the number of samples taken.
 java.lang.Double getAverageNumberOfActiveWO()
          Gets the ratio of the sum of work objects that are alive in the system to the number of samples taken.
 java.lang.Double getChildCreationRate()
          Gets the rate at which the application created child work objects in the time interval, based on the time units entered.
 java.lang.Double getChildrenGrowRate()
          Gets the rate at which child work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
 java.lang.Double getChildTerminationRate()
          Gets the rate at which the application terminated child work objects in the time interval, based on the time units entered.
 java.lang.String getClassName()
          Provides the name of the class ( Queue or Roster ) whose statistics are to be retrieved.
 java.util.Date getEndTime()
          Gets the time the evaluated request completed on the server.
 java.util.Date getEvaluationTime()
          Gets the timestamp for the evaluation period for the request.
 java.lang.Double getInitialNumberOfWO()
          Gets the number of work objects at the beginning of the time interval.
 java.lang.Double getNumberOfActiveChildWO()
          Determines how many active child work objects existed at the sample point.
 java.lang.Double getNumberOfActiveParentWO()
          Determines how many active parent work objects existed at the sample point.
 java.lang.Double getNumberOfCreatedChildWO()
          Determines how many child work objects the application created within the time interval.
 java.lang.Double getNumberOfCreatedParentWO()
          Determines how many parent work objects the application created within the time interval.
 java.lang.Double getNumberOfInitialChildWO()
          Gets the initial number of child work objects at the beginning of the time interval.
 java.lang.Double getNumberOfInitialParentWO()
          Gets the number of parent work objects at the beginning of the time interval.
 java.lang.Double getNumberOfRemainingChildWO()
          Gets the number of child work objects that are still active at the end of the time interval.
 java.lang.Double getNumberOfRemainingParentWO()
          Gets the number of parent work objects that are alive at the end of the time interval.
 java.lang.Double getNumberOfSamples()
          Gets a number that indicates the number the number of samples taken within the interval.
 java.lang.Double getNumberOfTerminatedChildWO()
          Determines how many child work objects the application terminated since the beginning of the time interval.
 java.lang.Double getNumberOfTerminatedParentWO()
          Determines how many parent work objects the application terminated since the beginning of the time interval.
 java.lang.Double getNumberOfUnitsInPeriod()
          Gets a count that indicates the number of units in the given time interval.
 java.lang.Double getParentCreationRate()
          Gets the rate at which the application created parent work objects in the time interval, based on the time units entered.
 java.lang.Double getParentGrowRate()
          Gets the rate at which parent work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
 java.lang.Double getParentTerminationRate()
          Gets the rate at which the application terminated parent work objects in the time interval, based on the time units entered.
 java.util.Date getRequestedEndTime()
          Gets the time value the user specified as the end time for the queue statistics evaluation.
 java.util.Date getRequestedStartTime()
          Gets the time value the user specified as the start time for the queue statistics evaluation.
 int getRequestedTimeUnit()
          Gets evaluation period unit of measure (or interval) specified by the user (for example: minutes, hours, days, etc.).
 java.lang.String getRosterName()
          Gets the name of the roster for the statistics being retrieved.
 java.util.Date getStartTime()
          Gets the time the evaluated request began on the server.
 java.lang.Double getSummationActiveChild()
          Determines how many child work objects are alive in the system.
 java.lang.Double getSummationActiveParent()
          Determines how many parent work objects are alive in the system.
 java.lang.Double getSummationActiveWO()
          Determines how many work objects are alive in the system.
 java.lang.Double getSummationChildLifeSpan()
          Gets the life span of the child work objects.
 java.lang.Double getSummationParentLifeSpan()
          Gets the life span of the parent work objects.
 java.lang.Double getSummationWOLifeSpan()
          Gets the life span of the work objects.
 java.lang.Double getTotalCreationRate()
          Gets the rate at which the application created work objects in the time interval, based on the time units entered.
 java.lang.Double getTotalGrowRate()
          Gets the rate at which work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
 java.lang.Double getTotalNumberOfActiveWO()
          Determines how many active work objects existed at the sample point.
 java.lang.Double getTotalNumberOfCreatedWO()
          Determines how many work objects the application created within the time interval.
 java.lang.Double getTotalNumberOfRemainingWO()
          Gets the number of work objects that are alive at the end of the time interval.
 java.lang.Double getTotalNumberOfTerminatedWO()
          Determines how many work objects the application terminated since the beginning of the time interval.
 java.lang.Double getTotalTerminationRate()
          Gets the rate at which the application terminated work objects in the time interval, based on the time units entered.
 java.lang.String toString()
          Gets the work class name and the interval start and end times in a specific 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()
Gets the timestamp for the evaluation period for the request.
Overrides:
getEvaluationTime in class filenet.vw.api.VWStatistics
Returns:
A date value that represents a timestamp of when the application evaluated the request on the server.

getStartTime

public java.util.Date getStartTime()
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.
Overrides:
getStartTime in class filenet.vw.api.VWStatistics
Returns:
A time value indicating the time the request began.

getEndTime

public java.util.Date getEndTime()
Gets the time the evaluated request completed on the server. The end time and start time, which can be requested with getStartTime(), may be different than the times requested by the caller; these time values are based on the actual snapshot stored on the database.
Overrides:
getEndTime in class filenet.vw.api.VWStatistics
Returns:
A time value indicating the time the request completed.

getRequestedStartTime

public java.util.Date getRequestedStartTime()
Gets the time value the user specified as the start time for the queue statistics evaluation.
Overrides:
getRequestedStartTime in class filenet.vw.api.VWStatistics
Returns:
A time value indicating the start time requested by a user.

getRequestedEndTime

public java.util.Date getRequestedEndTime()
Gets the time value the user specified as the end time for the queue statistics evaluation.
Overrides:
getRequestedEndTime in class filenet.vw.api.VWStatistics
Returns:
A time value indicating the end time requested by a user.

getRequestedTimeUnit

public int getRequestedTimeUnit()
Gets evaluation period unit of measure (or interval) specified by the user (for example: minutes, hours, days, etc.).
Overrides:
getRequestedTimeUnit in class filenet.vw.api.VWStatistics
Returns:
An integer value indicating the unit of measurement for the time value. Valid integer values are as follows:

  • 1: Minutes
  • 2: Hours
  • 3: Days
  • 4: Weeks
  • 5: Months
  • 6: Years

See Also:
VWTimeUnitType

getNumberOfUnitsInPeriod

public java.lang.Double getNumberOfUnitsInPeriod()
Gets a count that indicates the number of units in the given time interval. The statistics are evaluated by the unit of measurement specified by the user.
Overrides:
getNumberOfUnitsInPeriod in class filenet.vw.api.VWStatistics
Returns:
A number value indicating the units that are adjusted by the specified unit of time (or interval).

getNumberOfSamples

public java.lang.Double getNumberOfSamples()
Gets a number that indicates the number the number of samples taken within the interval.
Overrides:
getNumberOfSamples in class filenet.vw.api.VWStatistics
Returns:
An integer value indicating the total number of samples taken during the evaluation period.

getRosterName

public java.lang.String getRosterName()
Gets the name of the roster for the statistics being retrieved.
Returns:
The name of the roster being sampled for statistical information.

getInitialNumberOfWO

public java.lang.Double getInitialNumberOfWO()
Gets the number of work objects at the beginning of the time interval.
Returns:
An integer value that indicates the number of work objects at the beginning of the time interval.

getNumberOfInitialParentWO

public java.lang.Double getNumberOfInitialParentWO()
Gets the number of parent work objects at the beginning of the time interval. The application creates child work objects from a split operation, but it does not split parent work objects.
Returns:
A number that indicates the number of parent work objects at the beginning of the time interval.

getNumberOfInitialChildWO

public java.lang.Double getNumberOfInitialChildWO()
Gets the initial number of child work objects at the beginning of the time interval. Child work objects are derived from a split operation. (A parent that is also a child is counted only as a child.)
Returns:
A number that indicates the number of child work objects at the beginning of the time interval.

getTotalNumberOfRemainingWO

public java.lang.Double getTotalNumberOfRemainingWO()
Gets the number of work objects that are alive at the end of the time interval.
Returns:
A number that indicates the number of number of work objects remaining at the end of the time interval.

getNumberOfRemainingParentWO

public java.lang.Double getNumberOfRemainingParentWO()
Gets the number of parent work objects that are alive at the end of the time interval.
Returns:
A number that indicates the number of parent work objects remaining at the end of the time interval.

getNumberOfRemainingChildWO

public java.lang.Double getNumberOfRemainingChildWO()
Gets the number of child work objects that are still active at the end of the time interval.
Returns:
A number that indicates the number of child work objects remaining at the end of the time interval.

getTotalNumberOfCreatedWO

public java.lang.Double getTotalNumberOfCreatedWO()
Determines how many work objects the application created within the time interval.
Returns:
A number that indicates the total number of work objects created during the evaluation interval.

getNumberOfCreatedParentWO

public java.lang.Double getNumberOfCreatedParentWO()
Determines how many parent work objects the application created within the time interval.
Returns:
A number that indicates the number of parent work objects created within the evaluation interval.

getNumberOfCreatedChildWO

public java.lang.Double getNumberOfCreatedChildWO()
Determines how many child work objects the application created within the time interval.
Returns:
A number that indicates the number of child work objects created within the time interval.

getTotalNumberOfTerminatedWO

public java.lang.Double getTotalNumberOfTerminatedWO()
Determines how many work objects the application terminated since the beginning of the time interval.
Returns:
A number that indicates the number of work objects terminated since the beginning of the time interval.

getNumberOfTerminatedParentWO

public java.lang.Double getNumberOfTerminatedParentWO()
Determines how many parent work objects the application terminated since the beginning of the time interval.
Returns:
A number that indicates the number of parent work objects terminated since the beginning of the time interval.

getNumberOfTerminatedChildWO

public java.lang.Double getNumberOfTerminatedChildWO()
Determines how many child work objects the application terminated since the beginning of the time interval.
Returns:
A number that indicates the number of Child work objects terminated since the beginning of the time interval.

getTotalCreationRate

public java.lang.Double getTotalCreationRate()
Gets the rate at which the application created work objects in the time interval, based on the time units entered.
Returns:
A number that indicates the rate at which the application created work objects.

getParentCreationRate

public java.lang.Double getParentCreationRate()
Gets the rate at which the application created parent work objects in the time interval, based on the time units entered.
Returns:
A number that indicates the rate at which the application created parent work objects.

getChildCreationRate

public java.lang.Double getChildCreationRate()
Gets the rate at which the application created child work objects in the time interval, based on the time units entered.
Returns:
A number that indicates the rate at which the application created child work objects.

getTotalTerminationRate

public java.lang.Double getTotalTerminationRate()
Gets the rate at which the application terminated work objects in the time interval, based on the time units entered.
Returns:
A number that indicates the rate at which the application terminated work objects.

getParentTerminationRate

public java.lang.Double getParentTerminationRate()
Gets the rate at which the application terminated parent work objects in the time interval, based on the time units entered.
Returns:
A number that indicates the rate at which the application terminated parent work objects.

getChildTerminationRate

public java.lang.Double getChildTerminationRate()
Gets the rate at which the application terminated child work objects in the time interval, based on the time units entered.
Returns:
A number that indicates the rate at which the application terminated child work objects.

getTotalGrowRate

public java.lang.Double getTotalGrowRate()
Gets the rate at which work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
Returns:
A number that indicates the rate at which work objects grew in the system.

getParentGrowRate

public java.lang.Double getParentGrowRate()
Gets the rate at which parent work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
Returns:
A number that indicates the rate at which parent work objects grew in the system.

getChildrenGrowRate

public java.lang.Double getChildrenGrowRate()
Gets the rate at which child work objects grew in the system; the rate indicates the relationship as a ratio of the creation rate to the termination rate.
Returns:
A number that indicates the rate at which child work objects grew in the system.

getSummationWOLifeSpan

public java.lang.Double getSummationWOLifeSpan()
Gets the life span of the work objects.
Returns:
A number that indicates the life span of the work objects.

getSummationParentLifeSpan

public java.lang.Double getSummationParentLifeSpan()
Gets the life span of the parent work objects.
Returns:
A number that indicates the life span of the parent work objects.

getSummationChildLifeSpan

public java.lang.Double getSummationChildLifeSpan()
Gets the life span of the child work objects.
Returns:
A number that indicates the life span of the child work objects.

getAverageNumberOfActiveWO

public java.lang.Double getAverageNumberOfActiveWO()
Gets the ratio of the sum of work objects that are alive in the system to the number of samples taken.
Returns:
A number that indicates the ratio of active work objects to number of samples taken.

getAverageNumberOfActiveParentWO

public java.lang.Double getAverageNumberOfActiveParentWO()
Gets the ratio of the sum of parent work objects that are alive in the system to the number of samples taken.
Returns:
A number that indicates the ratio of active parent work objects to number of samples taken.

getAverageNumberOfActiveChildWO

public java.lang.Double getAverageNumberOfActiveChildWO()
Gets the ratio of the sum of child work objects that are alive in the system to the number of samples taken.
Returns:
A number that indicates the ratio of active child work objects to number of samples taken.

getAverageLifeSpanOfWO

public java.lang.Double getAverageLifeSpanOfWO()
Gets the average life span of work objects since the beginning of the time interval.
Returns:
A number that indicates the average life span of work objects since the beginning of the interval.

getAverageLifeSpanParentWO

public java.lang.Double getAverageLifeSpanParentWO()
Gets the average life span of parent work objects since the beginning of the time interval.
Returns:
A number that indicates the average life span of parent work objects since the beginning of the interval.

getAverageLifeSpanChildWO

public java.lang.Double getAverageLifeSpanChildWO()
Gets the average life span of child work objects since the beginning of the time interval.
Returns:
A number that indicates the average life span of child work objects since the beginning of the interval.

getSummationActiveWO

public java.lang.Double getSummationActiveWO()
Determines how many work objects are alive in the system.
Returns:
A number that indicates the number of work objects that are alive in the system.

getSummationActiveParent

public java.lang.Double getSummationActiveParent()
Determines how many parent work objects are alive in the system.
Returns:
A number that indicates the number of parent work objects that are alive in the system.

getSummationActiveChild

public java.lang.Double getSummationActiveChild()
Determines how many child work objects are alive in the system.
Returns:
A number that indicates the number of child work objects that are alive in the system.

getTotalNumberOfActiveWO

public java.lang.Double getTotalNumberOfActiveWO()
Determines how many active work objects existed at the sample point.
Returns:
A number that indicates the number of active work objects at the sample point.

getNumberOfActiveParentWO

public java.lang.Double getNumberOfActiveParentWO()
Determines how many active parent work objects existed at the sample point.
Returns:
A number that indicates the number of active parent work objects at the sample point.

getNumberOfActiveChildWO

public java.lang.Double getNumberOfActiveChildWO()
Determines how many active child work objects existed at the sample point.
Returns:
A number that indicates the number of active child work objects at the sample point.

toString

public java.lang.String toString()
Gets the work class name and the interval start and end times in a specific string format. The format is as follows:

"<RosterName> from <StartTime> to <EndTime>".

Overrides:
toString in class java.lang.Object
Returns:
The name of the work object.

getClassName

public java.lang.String getClassName()
Provides the name of the class ( Queue or Roster ) whose statistics are to be retrieved.
Returns:
name of the class ( Queue or Roster )

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.