Package lumis.portal.clock

Interface IServiceClock

All Known Implementing Classes:

ApmGlobalCollectorClock, AuditEntryCleanerClock, ChatClock, ClearImageEditionClock, ContentClock, ContentVersionCleanerClock, DeleteCreatedOrphanInterfaceInstances, DeleteExpiredDurableMessagesClock, DeleteOrphanWidgetInstanceHolders, DeleteUnusedHtmlFieldWidgetInstance, GenericServiceClock, ImportPrincipalClock, JourneyClearAbandonedInstancesClock, LockClock, MailMarketingClock, MaxMindDBUpdateClock, MonitorCleanupClock, NewsletterClock, OldActivityCleanerClock, PageCacheCleanupClock, PopularityClock, ResumeFlowClock, SendDashboardEmailClock, SendMailClock, SessionClock, SitemapClock, UnusedTagsCleanerClock, UpgradeCheckClock, UploadTempFilesDeleteClock, UserSegmentationGroupGenerationClock

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

Service Clock Interface

Since:

4.0.0

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

Field Summary

Fields

Modifier and Type	Field	Description
static int	CLOCK_TICK_SERVICE	Deprecated. Unused.
static int	CLOCK_TICK_SERVICE_INSTANCE	Deprecated. Unused.
static int	CLOCK_TICK_SERVICE_INTERFACE	Deprecated. Unused.
static int	CLOCK_TICK_SERVICE_INTERFACE_INSTANCE	Deprecated. Unused.

Method Summary

Modifier and Type	Method	Description
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