Package lumis.portal.processqueue

Class QueueTaskScheduleConfig

  • public class QueueTaskScheduleConfig
extends java.lang.Object
    Configuration for the scheduling of a IQueueTask.

    The same configuration object may be reused for different calls to IProcessQueueManager.schedule(IQueueTask, QueueTaskScheduleConfig). Changes to this configuration object will have no effect on tasks already scheduled with it. This class is not thread-safe.

    Since:
    7.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> getExclusiveLocks()
      Returns the exclusive locks for this task.
      java.lang.String getOwnerId()
      Returns the owner identifier set in this configuration.
      java.util.Date getScheduledDateTime()
      Returns the scheduled date-time for the execution of the task.
      java.util.Set<java.lang.String> getSharedLocks()
      Returns the shared locks for this task.
      java.lang.String getTitle()
      Returns the title for the task set in this configuration.
      void setOwnerId​(java.lang.String ownerId)
      Sets the identifier of the task's owner.
      void setScheduledDateTime​(java.util.Date scheduledDateTime)
      Sets the scheduled date-time for the execution of the task.
      void setTitle​(java.lang.String title)
      Sets the title for the task, to help identify it in the task queue.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • QueueTaskScheduleConfig

        public QueueTaskScheduleConfig()

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Returns the title for the task set in this configuration. It is intended to help identify the task in the task queue.

        If this property is null, an automatic title will be used when the task is scheduled. It is strongly recommended to specify the title to help troubleshooting.

        Returns:
        the title, or null if it has not been configured.
        Since:
        7.0.0
        See Also:
        setTitle(String)

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title for the task, to help identify it in the task queue.

        If this property is null, an automatic title will be used when the task is scheduled. It is strongly recommended to specify the title to help troubleshooting.

        Parameters:
        title - the title.
        Since:
        7.0.0

      • getOwnerId

        public java.lang.String getOwnerId()
        Returns the owner identifier set in this configuration.
        Returns:
        the owner identifier set in this configuration, or null if it was not set.
        Since:
        7.0.0
        See Also:
        setOwnerId(String)

      • setOwnerId

        public void setOwnerId​(java.lang.String ownerId)
        Sets the identifier of the task's owner. Its exact meaning is not known by the process queue framework, and is intended to allow the framework's client to query tasks of a specific owner.
        Parameters:
        ownerId - the identifier of the owner of the task. It must be a guid, or null if no owner information is to be stored.
        Since:
        7.0.0

      • getScheduledDateTime

        public java.util.Date getScheduledDateTime()
        Returns the scheduled date-time for the execution of the task.
        Returns:
        the scheduled date-time, or null if the task has no constraint on the date-time to be available to run.
        Since:
        7.0.0

      • setScheduledDateTime

        public void setScheduledDateTime​(java.util.Date scheduledDateTime)
        Sets the scheduled date-time for the execution of the task. If set, the task will not run before the specified date-time. While its scheduled date-time is not reached, any locks in it will not block any other process.
        Parameters:
        scheduledDateTime - the scheduled date-time, or null if the task has no constraint on the date-time to be available to run.
        Since:
        7.0.0

      • getSharedLocks

        public java.util.Set<java.lang.String> getSharedLocks()
        Returns the shared locks for this task.

        A task with a shared lock will not allow any newer task with the same value as an exclusive lock to execute before it.

        Returns:
        a modifiable set containing the shared locks for this task configuration. Any change on the set will be applied to this configuration.
        Since:
        7.0.0
        See Also:
        getExclusiveLocks(), lumis.portal.processqueue