Package net.solarnetwork.central.domain

Interface ClaimableJobState

public interface ClaimableJobState
API for a claimable job state.

At a basic level, jobs are added to a work queue and start in a "queued" state. Some worker process can then claim ownership a "queued" job and change the state to "claimed" and then "executing". Once the job is finished, the worker process changes the state to "completed".

Since:
1.44

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final char
    CLAIMED_KEY
    The standard key for a "claimed" state.
    static final char
    COMPLETED_KEY
    The standard key for a "completed" state.
    static final char
    EXECUTING_KEY
    The standard key for a "executing" state.
    static final char
    QUEUED_KEY
    The standard key for a "queued" state.
    static final char
    UNKNOWN_KEY
    The standard key for a "unknwon" state.

  • Method Summary

    Modifier and Type
    Method
    Description
    char
    getKey()
    Get a unique key for this state.

  • Field Details

    • UNKNOWN_KEY

      static final char UNKNOWN_KEY
      The standard key for a "unknwon" state.
      See Also:

    • QUEUED_KEY

      static final char QUEUED_KEY
      The standard key for a "queued" state.
      See Also:

    • CLAIMED_KEY

      static final char CLAIMED_KEY
      The standard key for a "claimed" state.
      See Also:

    • EXECUTING_KEY

      static final char EXECUTING_KEY
      The standard key for a "executing" state.
      See Also:

    • COMPLETED_KEY

      static final char COMPLETED_KEY
      The standard key for a "completed" state.
      See Also:

  • Method Details

    • getKey

      char getKey()
      Get a unique key for this state.
      Returns:
      the state key