com.spss.psapi.task

Class ExecutionState



  • public final class ExecutionState
    extends Enum
    This class enumerates the task execution states.
    Since:
    PSAPI 1.0
    Version:
    1.0
    Author:
    Rob Duncan
    See Also:
    ExecutionHandle
    Specification Status:
    Under Development
    • Field Detail

      • SUBMITTED

        public static final ExecutionState SUBMITTED
        The task has been submitted for execution but not yet started.
      • EXECUTING

        public static final ExecutionState EXECUTING
        The task is still executing.
      • SUCCESS

        public static final ExecutionState SUCCESS
        The task has completed successfully.
      • ERROR

        public static final ExecutionState ERROR
        The task has completed with an error.
      • TERMINATED

        public static final ExecutionState TERMINATED
        The task has completed prematurely as the result of a terminate request.
      • TERMINATING

        public static final ExecutionState TERMINATING
        A terminate request has been issued but the task has not yet completed.
    • Method Detail

      • getEnum

        public static ExecutionState getEnum(java.lang.String name)
        Returns the enumeration with the supplied name or null if no enumeration exists for the supplied name.
        Parameters:
        name - the enumeration name
        Returns:
        the enumeration with the supplied name or null
      • getValues

        public static ExecutionState[] getValues()
        Returns an array containing all the valid values for this enumeration class.
        Returns:
        an array containing all the valid values for this enumeration class
      • isCompletedState

        public boolean isCompletedState()
        Returns true if this state represents a task that is no longer executing. This true for SUCCESS, TERMINATED and ERROR states.
        Returns:
        true if this state represents a task that is no longer executing
        Since:
        PSAPI 1.1.2

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.