|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWRosterStats
public final class VWRosterStats
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.
VWQueueStats
,
Serialized FormMethod 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.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 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 grow rate is the relationship defined as the 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 grow rate is the relationship defined as the 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. |
void |
setSession(filenet.vw.server.IPECommands sess)
Set the command session associated with this statistics object. |
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 |
---|
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 java.util.Date getEvaluationTime()
public java.util.Date getStartTime()
public java.util.Date getEndTime()
public java.util.Date getRequestedStartTime()
public java.util.Date getRequestedEndTime()
public int getRequestedTimeUnit()
VWTimeUnitType
public java.lang.Double getNumberOfUnitsInPeriod()
public java.lang.Double getNumberOfSamples()
public java.lang.String getRosterName()
public java.lang.Double getInitialNumberOfWO()
public java.lang.Double getNumberOfInitialParentWO()
public java.lang.Double getNumberOfInitialChildWO()
public java.lang.Double getTotalNumberOfRemainingWO()
public java.lang.Double getNumberOfRemainingParentWO()
public java.lang.Double getNumberOfRemainingChildWO()
public java.lang.Double getTotalNumberOfCreatedWO()
public java.lang.Double getNumberOfCreatedParentWO()
public java.lang.Double getNumberOfCreatedChildWO()
public java.lang.Double getTotalNumberOfTerminatedWO()
public java.lang.Double getNumberOfTerminatedParentWO()
public java.lang.Double getNumberOfTerminatedChildWO()
public java.lang.Double getTotalCreationRate()
public java.lang.Double getParentCreationRate()
public java.lang.Double getChildCreationRate()
public java.lang.Double getTotalTerminationRate()
public java.lang.Double getParentTerminationRate()
public java.lang.Double getChildTerminationRate()
public java.lang.Double getTotalGrowRate()
public java.lang.Double getParentGrowRate()
public java.lang.Double getChildrenGrowRate()
public java.lang.Double getSummationWOLifeSpan()
public java.lang.Double getSummationParentLifeSpan()
public java.lang.Double getSummationChildLifeSpan()
public java.lang.Double getAverageNumberOfActiveWO()
public java.lang.Double getAverageNumberOfActiveParentWO()
public java.lang.Double getAverageNumberOfActiveChildWO()
public java.lang.Double getAverageLifeSpanOfWO()
public java.lang.Double getAverageLifeSpanParentWO()
public java.lang.Double getAverageLifeSpanChildWO()
public java.lang.Double getSummationActiveWO()
public java.lang.Double getSummationActiveParent()
public java.lang.Double getSummationActiveChild()
public java.lang.Double getTotalNumberOfActiveWO()
public java.lang.Double getNumberOfActiveParentWO()
public java.lang.Double getNumberOfActiveChildWO()
public java.lang.String toString()
"<RosterName> from <StartTime> to <EndTime>".
toString
in class java.lang.Object
public java.lang.String getClassName()
public void setSession(filenet.vw.server.IPECommands sess) throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |