Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal.utils
Interface ICounterStore

All Known Implementing Classes:
  RDBMCounterStore

    public interface ICounterStore

A store interface that keeps track of multiple unique ID counters.

Version:
  $Revision: 1.2 $
Author:
  Peter Kharchenko

Method Summary
`void` | `createCounter(java.lang.String counterName)` Create a new coutner
`int` | `getIncrementIntegerId(java.lang.String counterName)` Obtain current coutner value and increment it.
`void` | `setCounter(java.lang.String counterName, int value)` Reset a value of a counter.

Method Detail

### createCounter

    void createCounter(java.lang.String counterName)
                       throws java.lang.Exception

  Create a new coutner

  Parameters:
    `counterName` - a name for the new counter
  Throws:
    `java.lang.Exception` - if an error occurs

### setCounter

    void setCounter(java.lang.String counterName,
                    int value)
                    throws java.lang.Exception

  Reset a value of a counter.

  Parameters:
    `counterName` - a counter name
    `value` - a new counter value
  Throws:
    `java.lang.Exception` - if an error occurs

### getIncrementIntegerId

    int getIncrementIntegerId(java.lang.String counterName)
                              throws java.lang.Exception

  Obtain current coutner value and increment it.

  Parameters:
    `counterName` - a `String` value
  Returns:
    an `int` value
  Throws:
    `java.lang.Exception` - if an error occurs

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD