Interface IServiceClock

    • 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

        java.util.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