org.jasig.portal.utils
Interface ICounterStore

All Known Implementing Classes:

PooledCounterStore, RDBMCounterStore

public interface ICounterStore

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

Version:

$Revision: 19776 $

Author:

Peter Kharchenko pkharchenko@interactivebusiness.com"

Method Summary

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

Method Detail

createCounter

void createCounter(String counterName)
                   throws Exception

Create a new coutner

Parameters:

counterName - a name for the new counter

Throws:

Exception - if an error occurs

setCounter

void setCounter(String counterName,
                int value)
                throws Exception

Reset a value of a counter.

Parameters:

counterName - a counter name

value - a new counter value

Throws:

Exception - if an error occurs

getIncrementIntegerId

int getIncrementIntegerId(String counterName)
                          throws Exception

Obtain current coutner value and increment it.

Parameters:

counterName - a String value

Returns:

an int value

Throws:

Exception - if an error occurs