Package com.avoka.fc.core.entity

Class Job

  • All Implemented Interfaces:
    IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
    public class Job
extends _Job
    Provides a Collaboration Job entity.
    Since:
    4.0.0
    See Also:
    Serialized Form

    • Constructor Detail

      • Job

        public Job()

    • Method Detail

      • isStatusCancelled

        public boolean isStatusCancelled()
        Returns:
        true if the Job is "Cancelled"

      • isStatusCompleted

        public boolean isStatusCompleted()
        Returns:
        true if the Job is "Completed"

      • isStatusError

        public boolean isStatusError()
        Returns:
        true if the Job is "Error"

      • isStatusExpired

        public boolean isStatusExpired()
        Returns:
        true if the Job is "Expired"

      • isStatusInProgress

        public boolean isStatusInProgress()
        Returns:
        true if the Job is "In Progress"

      • isStatusPaused

        public boolean isStatusPaused()
        Returns:
        true if the Job is "Paused"

      • getJobPropertyMap

        public Map<String,​String> getJobPropertyMap()
        Return an unmodifiable map of job property values, ordered by property id.
        Returns:
        an unmodifiable map of job property values, ordered by property id

      • getJobProperty

        public JobProperty getJobProperty​(String name)
        Return the job property with the given name
        Parameters:
        name - the job property name (required)
        Returns:
        the matching job property, or null if not found
        Since:
        4.1.0

      • getJobPropertyValue

        public String getJobPropertyValue​(String name)
        Return the named job property with the value or null if not defined.
        Parameters:
        name - the job property name (required)
        Returns:
        the job property value
        Since:
        4.1.0

      • setJobPropertyValue

        public void setJobPropertyValue​(String name,
                                String value)
        Set the named job property with the given value, or create a new job property if it does not exist.
        Parameters:
        name - the job property name (required)
        value - the job property value, if the value is null the job property for the name will be deleted.
        Since:
        4.1.0

      • getOrderedJobActions

        public List<JobAction> getOrderedJobActions()
        Returns:
        the list of job actions ordered by id.

      • getOrderedJobActionsDesc

        public List<JobAction> getOrderedJobActionsDesc()
        Returns:
        the list of job actions ordered by id desc.

      • getOrderedJobSteps

        public List<JobStep> getOrderedJobSteps()
        Returns:
        the list of job steps ordered by id.

      • getOrderedJobStepsDesc

        public List<JobStep> getOrderedJobStepsDesc()
        Returns:
        the list of job steps ordered by id desc.

      • getFirstSubmission

        public Submission getFirstSubmission()
        Return the first submission of the job.
        Returns:
        the first submission of the job.

      • toString

        public String toString()
        Overrides:
        toString in class BaseEntity
        Returns:
        the string representation of this object.

      • toDumpString

        public String toDumpString()
        Returns:
        the full job state dump representation of this object for debugging purposes.

      • getPreviousStepName

        public String getPreviousStepName()
        Returns the name of the previous step, relative to the current step.
        Returns:
        the previous step name

      • printJobDump

        public void printJobDump()
        Print the job dump string to System.out.

      • getJobDef

        public JobDef getJobDef()
        Return the JobDef descriptor associated with the Job instance service controller, or null if not defined.
        Returns:
        the JobDef descriptor associated with the Job instance service controller, or null if not defined.

      • addToSubmissions

        public void addToSubmissions​(Submission obj)
        Add the Submissions object.
        Overrides:
        addToSubmissions in class _Job
        Parameters:
        obj - the submissions value to add

      • getJobGroupNames

        public String getJobGroupNames()
        Return the job group names, sorted ascending.
        Returns:
        the job group names.
        Since:
        17.10.0