IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.bc.counter
Class Counter

java.lang.Object
  extended by com.ibm.btt.bc.counter.Counter

public class Counter
extends java.lang.Object


Constructor Summary
Counter()
          This constructor creates a Counter object with three counter element: total, increase and increaseTimes.
Counter(float increaseMaxLimit, float totalMaxLimit, int increaseTimesMaxLimit)
          This constructor creates a Counter object with three counter element: total, increase and increaseTimes.
 
Method Summary
 float currentTotal()
          Returns the current total value.
 float getIncreaseMaxLimit()
          Returns the MaxLimit property of increase CounterElement.
 float getIncreaseMinLimit()
          Returns the MinLimit property of increase CounterElement.
 int getIncreaseTimesMaxLimit()
          Returns the MaxLimit property of TotIncrs CounterElement.
 int getIncreaseTimesMinLimit()
          Returns the MinLimit property of TotIncrs CounterElement.
 float getTotalMaxLimit()
          Returns the MaxLimit property of Total CounterElement.
 float getTotalMinLimit()
          Returns the MinLimit property of Total CounterElement.
 void increase(float incrValue)
          Sets the increase value.
 int increaseTimes()
          Returns the increase times value.
 void setIncreaseMaxLimit(float maxLimit)
          Sets the MaxLimit property of increase.
 void setIncreaseMinLimit(float minLimit)
          Sets the MinLimit property of increase.
 void setIncreaseTimes(int totalCount)
          Sets the value of increaseTimes.
 void setIncreaseTimesMaxLimit(int maxLimit)
          Sets the maxLimit property of increaseTimes.
 void setIncreaseTimesMinLimit(int minLimit)
          Sets the minLimit property of increaseTimes.
 void setTotal(float totalValue)
          Sets the value of Total.
 void setTotalMaxLimit(float maxLimit)
          Sets the maxLimit property of Total.
 void setTotalMinLimit(float minLimit)
          Sets the minLimit property of Total.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Counter

public Counter()
This constructor creates a Counter object with three counter element: total, increase and increaseTimes.


Counter

public Counter(float increaseMaxLimit,
               float totalMaxLimit,
               int increaseTimesMaxLimit)
        throws CounterException
This constructor creates a Counter object with three counter element: total, increase and increaseTimes. And initialize these elements' max limit value.

Parameters:
increaseMaxLimit: - the max limit value of increase element.
totalMaxLimit - the max limit value of total element.
increaseTimesMaxLimit - the max limit value of increaseTimes element.
Throws:
CounterException - if one of these values is incorrect.
Method Detail

increase

public void increase(float incrValue)
              throws CounterException
Sets the increase value.

It first tests if the value is correct then, if the value is correct, it sets it.

This method throws :

  1. - A CounterException if the value incrValue is not correct.

Throws:
CounterException

setIncreaseMaxLimit

public void setIncreaseMaxLimit(float maxLimit)
                         throws CounterException
Sets the MaxLimit property of increase.

It first tests if the maxLimit value is correct then, if the maxLimit value is correct, it sets it.

This method throws :

  1. - A CounterException if the value maxLimit is not correct.

Throws:
CounterException

setIncreaseMinLimit

public void setIncreaseMinLimit(float minLimit)
                         throws CounterException
Sets the MinLimit property of increase.

It first tests if the minLimit value is correct then, if the minLimit value is correct, it sets it.

This method throws :

  1. - A CounterException if the value minLimit is not correct.

Throws:
CounterException

getIncreaseMaxLimit

public float getIncreaseMaxLimit()
Returns the MaxLimit property of increase CounterElement.


getIncreaseMinLimit

public float getIncreaseMinLimit()
Returns the MinLimit property of increase CounterElement.


setTotal

public void setTotal(float totalValue)
              throws CounterException
Sets the value of Total.

It first tests if the value is correct then, if the value is correct, it sets it.

This method throws :

  1. - A CounterException if the value totalValue is not correct.

Throws:
CounterException

setTotalMaxLimit

public void setTotalMaxLimit(float maxLimit)
                      throws CounterException
Sets the maxLimit property of Total.

It first tests if the maxLimit value is correct then, if the maxLimit value is correct, it sets it.

This method throws :

  1. - A CounterException if the value maxLimit is not correct.

Throws:
CounterException

setTotalMinLimit

public void setTotalMinLimit(float minLimit)
                      throws CounterException
Sets the minLimit property of Total.

It first tests if the minLimit value is correct then, if the minLimit value is correct, it sets it.

This method throws :

  1. - A CounterException if the value minLimit is not correct.

Throws:
CounterException

currentTotal

public float currentTotal()
Returns the current total value.


getTotalMaxLimit

public float getTotalMaxLimit()
Returns the MaxLimit property of Total CounterElement.


getTotalMinLimit

public float getTotalMinLimit()
Returns the MinLimit property of Total CounterElement.


setIncreaseTimes

public void setIncreaseTimes(int totalCount)
                      throws CounterException
Sets the value of increaseTimes.

It first tests if the value is correct then, if the value is correct, it sets it.

This method throws :

  1. - A CounterException if the value totalCount is not correct.

Throws:
CounterException

setIncreaseTimesMaxLimit

public void setIncreaseTimesMaxLimit(int maxLimit)
                              throws CounterException
Sets the maxLimit property of increaseTimes.

It first tests if the maxLimit value is correct then, if the maxLimit value is correct, it sets it.

This method throws :

  1. - A CounterException if the value maxLimit is not correct.

Throws:
CounterException

setIncreaseTimesMinLimit

public void setIncreaseTimesMinLimit(int minLimit)
                              throws CounterException
Sets the minLimit property of increaseTimes.

It first tests if the minLimit value is correct then, if the minLimit value is correct, it sets it.

This method throws :

  1. - A CounterException if the value minLimit is not correct.

Throws:
CounterException

increaseTimes

public int increaseTimes()
Returns the increase times value.


getIncreaseTimesMaxLimit

public int getIncreaseTimesMaxLimit()
Returns the MaxLimit property of TotIncrs CounterElement.


getIncreaseTimesMinLimit

public int getIncreaseTimesMinLimit()
Returns the MinLimit property of TotIncrs CounterElement.


IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010