LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.data
Class LyMetricsTools

java.lang.Object
  extended by leon.data.LyMetricsTools

public class LyMetricsTools
extends java.lang.Object

Utility class to manage metrics.


Nested Class Summary
static class LyMetricsTools.MetricType
          Possible values for metric types.
 
Field Summary
static java.lang.String __VERSION
          File version
static java.lang.String METRIC_ACTION_ID
          Constant for metrics actionId field id.
static java.lang.String METRIC_CLASS
          Constant for metrics class id.
static java.lang.String METRIC_CLASS_ID
          Constant for metrics classId field id.
static java.lang.String METRIC_END_DATE
          Constant for metrics end date field id.
static java.lang.String METRIC_START_DATE
          Constant for metrics start date field id.
static java.lang.String METRIC_START_DURATION
          Constant for metrics start duration field id.
static java.lang.String METRIC_TYPE
          Constant for metrics type field id.
static java.lang.String METRIC_USER_ID
          Constant for metrics userId field id.
static java.lang.String METRIC_VALUE
          Constant for metrics value field id.
 
Constructor Summary
LyMetricsTools()
           
 
Method Summary
static boolean areMetricsActivated(LyDataSession session, LyMetricsTools.MetricType type)
          Indicates whether metrics area activated for a given session.
static LyObject createMetric(LyDataSession session, LyMetricsTools.MetricType type, java.util.Date startDate, java.lang.Long startDuration, java.util.Date endDate, java.lang.String actionId, java.lang.String classId, java.lang.String value)
          Creates a new metric and returns the LyObject instance.
static void setMetricEndDate(LyDataSession session, LyMetricsTools.MetricType type, LyObject metric, java.util.Date endDate)
          Sets the end date of a given metric.
static void setMetricUserId(LyDataSession session, LyMetricsTools.MetricType type, LyObject metric)
          Sets the userId of a given metric.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
File version

See Also:
Constant Field Values

METRIC_CLASS

public static java.lang.String METRIC_CLASS
Constant for metrics class id.


METRIC_TYPE

public static java.lang.String METRIC_TYPE
Constant for metrics type field id.


METRIC_START_DATE

public static java.lang.String METRIC_START_DATE
Constant for metrics start date field id.


METRIC_START_DURATION

public static java.lang.String METRIC_START_DURATION
Constant for metrics start duration field id.


METRIC_END_DATE

public static java.lang.String METRIC_END_DATE
Constant for metrics end date field id.


METRIC_USER_ID

public static java.lang.String METRIC_USER_ID
Constant for metrics userId field id.


METRIC_ACTION_ID

public static java.lang.String METRIC_ACTION_ID
Constant for metrics actionId field id.


METRIC_CLASS_ID

public static java.lang.String METRIC_CLASS_ID
Constant for metrics classId field id.


METRIC_VALUE

public static java.lang.String METRIC_VALUE
Constant for metrics value field id.

Constructor Detail

LyMetricsTools

public LyMetricsTools()
Method Detail

areMetricsActivated

public static boolean areMetricsActivated(LyDataSession session,
                                          LyMetricsTools.MetricType type)
Indicates whether metrics area activated for a given session.

Parameters:
session - current session.
Returns:
true if metrics are activated, false otherwise.

createMetric

public static LyObject createMetric(LyDataSession session,
                                    LyMetricsTools.MetricType type,
                                    java.util.Date startDate,
                                    java.lang.Long startDuration,
                                    java.util.Date endDate,
                                    java.lang.String actionId,
                                    java.lang.String classId,
                                    java.lang.String value)
Creates a new metric and returns the LyObject instance.


setMetricEndDate

public static void setMetricEndDate(LyDataSession session,
                                    LyMetricsTools.MetricType type,
                                    LyObject metric,
                                    java.util.Date endDate)
Sets the end date of a given metric.


setMetricUserId

public static void setMetricUserId(LyDataSession session,
                                   LyMetricsTools.MetricType type,
                                   LyObject metric)
Sets the userId of a given metric.


(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com