lumis.portal.clock
Interface IClockDao

All Known Implementing Classes:

ClockDaoJdbc

public interface IClockDao

Since:

4.0.0

Method Summary

void	add(ClockConfig clockConfig, ITransaction transaction) Add the clock.
void	addOrUpdate(ClockConfig clockConfig, ITransaction transaction) Add or update the clock.
void	delete(java.lang.String clockId, ITransaction transaction) Delete the clock.
java.util.List<ClockConfig>	findRunningClocks(ITransaction transaction) Get the running clocks.
ClockConfig	get(java.lang.String clockId, ITransaction transaction) Get the configuration of the clock.
java.util.List<java.lang.String>	getClockIds(ITransaction transaction) Get a list of ids of the clock.
java.util.Collection<java.lang.String>	getClockIdsByServiceId(java.lang.String serviceId, ITransaction transaction) Get a list of ids by passing the id of the service.
java.util.List<java.lang.String>	getNextSchedules(ITransaction transaction) Get next schedules.
boolean	setClockRunning(java.lang.String clockId, boolean runningState, int maxRunTime, ITransaction transaction) Set the running of the clock.
boolean	update(ClockConfig clockConfig, ITransaction transaction) Update the clock.

Method Detail

getClockIds

java.util.List<java.lang.String> getClockIds(ITransaction transaction)
                                             throws DaoException,
                                                    PortalException

Get a list of ids of the clock.

Parameters:

transaction -

Returns:

an array of Strings.

Throws:

DaoException

PortalException

getClockIdsByServiceId

java.util.Collection<java.lang.String> getClockIdsByServiceId(java.lang.String serviceId,
                                                              ITransaction transaction)
                                                              throws DaoException,
                                                                     PortalException

Get a list of ids by passing the id of the service.

Parameters:

serviceId -

transaction -

Returns:

an array of Strings.

Throws:

DaoException

PortalException

getNextSchedules

java.util.List<java.lang.String> getNextSchedules(ITransaction transaction)
                                                  throws DaoException,
                                                         PortalException

Get next schedules.

Parameters:

transaction -

Returns:

an array of Strings.

Throws:

DaoException

PortalException

findRunningClocks

java.util.List<ClockConfig> findRunningClocks(ITransaction transaction)
                                              throws DaoException,
                                                     PortalException

Get the running clocks.

Parameters:

transaction - the current transaction.

Returns:

a list of ClockConfig.

Throws:

DaoException

PortalException

Since:

6.0.0

get

ClockConfig get(java.lang.String clockId,
                ITransaction transaction)
                throws DaoException,
                       PortalException

Get the configuration of the clock.

Parameters:

clockId -

transaction -

Returns:

a ClockConfig.

Throws:

DaoException

PortalException

add

void add(ClockConfig clockConfig,
         ITransaction transaction)
         throws DaoException,
                PortalException

Add the clock.

Parameters:

clockConfig -

transaction -

Throws:

DaoException

PortalException

addOrUpdate

void addOrUpdate(ClockConfig clockConfig,
                 ITransaction transaction)
                 throws DaoException,
                        PortalException

Add or update the clock. This method add the clock if it don't exist.

Parameters:

clockConfig -

transaction -

Throws:

DaoException

PortalException

update

boolean update(ClockConfig clockConfig,
               ITransaction transaction)
               throws DaoException,
                      PortalException

Update the clock.

Parameters:

clockConfig -

transaction -

Returns:

Throws:

DaoException

PortalException

delete

void delete(java.lang.String clockId,
            ITransaction transaction)
            throws DaoException,
                   PortalException

Delete the clock.

Parameters:

clockId -

transaction -

Throws:

DaoException

PortalException

setClockRunning

boolean setClockRunning(java.lang.String clockId,
                        boolean runningState,
                        int maxRunTime,
                        ITransaction transaction)
                        throws DaoException,
                               PortalException

Set the running of the clock.

Parameters:

clockId -

runningState -

maxRunTime -

transaction -

Returns:

Throws:

DaoException

PortalException