lumis.portal.clock
Interface IServiceClock

Package class diagram package IServiceClock
All Known Implementing Classes:
ChatClock, ContentClock, DeleteExpiredDurableMessagesClock, GenericServiceClock, LockClock, MailMarketingClock, MonitorConsolidationClock, NewsletterClock, SendMailClock, SessionClock

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

Service Clock Interface

Since:
4.0.0

Field Summary
static int CLOCK_TICK_SERVICE
          Deprecated. Unused. May be removed in a future version.
static int CLOCK_TICK_SERVICE_INSTANCE
          Deprecated. Unused. May be removed in a future version.
static int CLOCK_TICK_SERVICE_INTERFACE
          Deprecated. Unused. May be removed in a future version.
static int CLOCK_TICK_SERVICE_INTERFACE_INSTANCE
          Deprecated. Unused. May be removed in a future version.
 
Method Summary
 void doTick(SessionConfig sessionConfig, ClockConfig clockConfig)
          Executes a clock tick.
 Date getNextScheduleTime(SessionConfig sessionConfig, ClockConfig clockConfig, ITransaction transaction)
          Returns the scheduled date-time for the next execution of a clock.
 

Field Detail

CLOCK_TICK_SERVICE

@Deprecated
static final int CLOCK_TICK_SERVICE
Deprecated. Unused. May be removed in a future version.
See Also:
Constant Field Values

CLOCK_TICK_SERVICE_INTERFACE

@Deprecated
static final int CLOCK_TICK_SERVICE_INTERFACE
Deprecated. Unused. May be removed in a future version.
See Also:
Constant Field Values

CLOCK_TICK_SERVICE_INSTANCE

@Deprecated
static final int CLOCK_TICK_SERVICE_INSTANCE
Deprecated. Unused. May be removed in a future version.
See Also:
Constant Field Values

CLOCK_TICK_SERVICE_INTERFACE_INSTANCE

@Deprecated
static final int CLOCK_TICK_SERVICE_INTERFACE_INSTANCE
Deprecated. Unused. May be removed in a future version.
See Also:
Constant Field Values
Method Detail

doTick

void doTick(SessionConfig sessionConfig,
            ClockConfig clockConfig)
            throws 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.

Parameters:
sessionConfig - the user session information.
clockConfig - the clock.
Throws:
PortalException

getNextScheduleTime

Date getNextScheduleTime(SessionConfig sessionConfig,
                         ClockConfig clockConfig,
                         ITransaction transaction)
                         throws PortalException
Returns the scheduled date-time for the next execution of a clock.

Parameters:
sessionConfig - the user session information.
clockConfig - the clock.
transaction - the transaction for persistence access.
Returns:
the date-time for next scheduled execution.
Throws:
PortalException


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.