lumis.portal.clock
Interface IServiceClock

All Known Implementing Classes:

ChatClock, ContentClock, DeleteExpiredDurableMessagesClock, GenericServiceClock, LockClock, MailMarketingClock, MonitorConsolidationClock, NewsletterClock, SendMailClock, SessionClock

@StableMinor(version="4.1",
             sinceVersion="4.0")
public interface IServiceClock

Service Clock Interface

Since:

4.0.0

Field Summary

static int	CLOCK_TICK_SERVICE
static int	CLOCK_TICK_SERVICE_INSTANCE
static int	CLOCK_TICK_SERVICE_INTERFACE
static int	CLOCK_TICK_SERVICE_INTERFACE_INSTANCE

Method Summary

void	doTick(SessionConfig sessionConfig, ClockConfig clockConfig) Executes a clock tick.
Date	getNextScheduleTime(SessionConfig sessionConfig, ClockConfig clockConfig, ITransaction transaction)

Field Detail

CLOCK_TICK_SERVICE

static final int CLOCK_TICK_SERVICE

See Also:

Constant Field Values

CLOCK_TICK_SERVICE_INTERFACE

static final int CLOCK_TICK_SERVICE_INTERFACE

See Also:

Constant Field Values

CLOCK_TICK_SERVICE_INSTANCE

static final int CLOCK_TICK_SERVICE_INSTANCE

See Also:

Constant Field Values

CLOCK_TICK_SERVICE_INTERFACE_INSTANCE

static final int CLOCK_TICK_SERVICE_INTERFACE_INSTANCE

See Also:

Constant Field Values

Method Detail

doTick

void doTick(SessionConfig sessionConfig,
            ClockConfig clockConfig)
            throws ServiceException,
                   PortalException

Executes a clock tick. This interface must be implemented by an object that handles clock ticks. Based on the service definition and/or the custom definition specified by the user this method will be called on regular intervals. The entityId could either be a serviceId, serviceInstanceId, interfaceId, or interfaceInstanceId. The entityType would correspondingly be one of the constants CLOCK_TICK_SERVICE, CLOCK_TICK_SERVICE_INTERFACE, CLOCK_TICK_SERVCE_INSTANCE, CLOCK_TICK_SERVICE_INTERFACE_INSTANCE

Parameters:

sessionConfig -

clockConfig -

Throws:

ServiceException

PortalException

getNextScheduleTime

Date getNextScheduleTime(SessionConfig sessionConfig,
                         ClockConfig clockConfig,
                         ITransaction transaction)
                         throws ServiceException,
                                PortalException

Parameters:

sessionConfig -

clockConfig -

transaction -

Returns:

a Date.

Throws:

ServiceException

PortalException