JobInfo (scheduling 14.1.0-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

JobInfoImpl, JobInfoImpl
```
@PublicAPI
public interface JobInfo
extends Serializable
```
JobInfo provides information about the Job it is linked with.
These information and only them are able to change inside the Job.

Since:

ProActive Scheduling 0.9

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map<Integer,Boolean>`	`getAttachedServices()` Returns a map of attached PSA services {ServiceId, EnableActions}
`String`	`getBucketName()` Returns the bucket name associated with this job
`int`	`getChildrenCount()` Return the number of children jobs
`long`	`getCumulatedCoreTime()` Returns the cumulated time consumed by task executions for this job
`String`	`getDescription()` Returns the description associated with this job
`Map<String,Map<String,JobVariable>>`	`getDetailedSignals()` Returns the map of signals and input variables
`Map<String,JobVariable>`	`getDetailedVariables()` Returns the variables Map with full definition
`String`	`getDomain()` Return the domain associated with the job owner
`Map<String,ExternalEndpoint>`	`getExternalEndpointUrls()` Returns a set of external endpoint urls
`long`	`getFinishedTime()` Returns the time at which the Job has finished.
`Map<String,String>`	`getGenericInformation()` Returns the generic information Map
`long`	`getInErrorTime()` Returns the time at which a Job was seen as in-error for the last time.
`JobId`	`getJobId()` Returns an identifier that uniquely identifies the Job within a Scheduler instance.
`String`	`getJobOwner()` Returns the name of the Job owner.
`String`	`getLabel()` Returns the label associated with this job
`long`	`getLastUpdatedTime()` Returns the time at which the last updated happened on the Job.
`int`	`getNumberOfFailedTasks()` Returns the number of tasks managed by the Job that are in a failed state due to a resource failure.
`int`	`getNumberOfFaultyTasks()` Returns the number of tasks managed by the Job that are in a faulty state.
`int`	`getNumberOfFinishedTasks()` Returns the number of tasks managed by the Job which are finished.
`int`	`getNumberOfInErrorTasks()` Returns the number of tasks managed by the Job that are in an in-error state.
`int`	`getNumberOfNodes()` Returns the number of nodes used by the job since the beginning of its execution
`int`	`getNumberOfNodesInParallel()` Returns the number of nodes in parallel used by the job since the beginning of its execution
`int`	`getNumberOfPendingTasks()` Returns the number of tasks managed by the Job which are pending.
`int`	`getNumberOfRunningTasks()` Returns the number of tasks managed by the Job which are running.
`Long`	`getParentId()` Return the parent id of the job
`List<String>`	`getPreciousTasks()` Return the list of tasks names with precious results
`JobPriority`	`getPriority()` Returns the priority of the Job.
`String`	`getProjectName()` Returns the project name associated with this job
`long`	`getRemovedTime()` Returns the time at which the Job has been marked as removed.
`long`	`getScheduledTimeForRemoval()` Returns the scheduled time for removal.
`Set<String>`	`getSignals()` Returns the set of signals used by the job
`Long`	`getStartAt()` Return the scheduled time of the job, defined by the generic information START_AT
`long`	`getStartTime()` Returns the time at which the Job has started.
`JobStatus`	`getStatus()` Return the status of the job.
`String`	`getSubmissionMode()` Returns the portal name via the job was submitted
`long`	`getSubmittedTime()` Returns the time at which the Job was submitted.
`String`	`getTenant()` Return the tenant associated with the job owner
`int`	`getTotalNumberOfTasks()` Returns the number of tasks managed by the Job.
`Map<String,String>`	`getVariables()` Returns the variables Map
`Map<String,String>`	`getVisualizationConnectionStrings()` Return a map of visualization connection strings key: task name value: connection string
`Map<String,String>`	`getVisualizationIcons()` Return a map of visualization icons key: task name value: icon associated with the task
`boolean`	`isResultMapPresent()` Return true if a non-empty result map is attached to this job
`boolean`	`isStarted()`
`boolean`	`isToBeRemoved()` Returns a boolean that indicates whether the job is marked for removal or not.
`void`	`setDetailedSignals(Map<String,Map<String,JobVariable>> detailedSignals)` Sets the map of job signals and input variables
`void`	`setSignals(Set<String> signals)` Sets the set of job signals
`void`	`setVisualizationConnectionStrings(Map<String,String> connectionStrings)` Sets the visualization connection string map
`void`	`setVisualizationIcons(Map<String,String> visualizationIcons)` Sets the visualization icons

- Method Detail
  - getJobId
```
JobId getJobId()
```
    Returns an identifier that uniquely identifies the Job within a Scheduler instance.
    
    Returns:
    
    an identifier that uniquely identifies the Job within a Scheduler instance.
  - getJobOwner
```
String getJobOwner()
```
    Returns the name of the Job owner.
    
    Returns:
    
    the name of the Job owner (the one who submitted the Job).
  - getTenant
```
String getTenant()
```
    Return the tenant associated with the job owner
    
    Returns:
    
    the tenant associated with the job owner or null if no tenant is associated
  - getDomain
```
String getDomain()
```
    Return the domain associated with the job owner
    
    Returns:
    
    the domain associated with the job owner or null if no tenant is associated
  - getProjectName
```
String getProjectName()
```
    Returns the project name associated with this job
    
    Returns:
    
    project name
  - getDescription
```
String getDescription()
```
    Returns the description associated with this job
    
    Returns:
    
    description
  - getBucketName
```
String getBucketName()
```
    Returns the bucket name associated with this job
    
    Returns:
    
    bucket name
  - getLabel
```
String getLabel()
```
    Returns the label associated with this job
    
    Returns:
    
    label
  - getSubmissionMode
```
String getSubmissionMode()
```
    Returns the portal name via the job was submitted
    
    Returns:
    
    portal name
  - getFinishedTime
```
long getFinishedTime()
```
    Returns the time at which the Job has finished.
    
    Returns:
    
    the time at which the Job has finished (i.e. all tasks have finished because of a normal or abnormal termination).
  - getRemovedTime
```
long getRemovedTime()
```
    Returns the time at which the Job has been marked as removed.
    
    Returns:
    
    the time at which the Job has been marked as removed.
  - getStartTime
```
long getStartTime()
```
    Returns the time at which the Job has started.
    
    Returns:
    
    the time at which the Job has started.
  - isStarted
```
boolean isStarted()
```
    Returns:
    
    true if job is already started
  - getInErrorTime
```
long getInErrorTime()
```
    Returns the time at which a Job was seen as in-error for the last time.
    
    Returns:
    
    the time at which a Job was seen as in-error for the last time. The default value is -1.
  - getSubmittedTime
```
long getSubmittedTime()
```
    Returns the time at which the Job was submitted.
    
    Returns:
    
    the time at which the Job was submitted.
  - getLastUpdatedTime
```
long getLastUpdatedTime()
```
    Returns the time at which the last updated happened on the Job.
    
    Returns:
    
    the time in long format.
  - getCumulatedCoreTime
```
long getCumulatedCoreTime()
```
    Returns the cumulated time consumed by task executions for this job
    
    Returns:
    
    sum of all time consumed by each task execution
  - getNumberOfNodes
```
int getNumberOfNodes()
```
    Returns the number of nodes used by the job since the beginning of its execution
    
    Returns:
    
    number of nodes used by the job
  - getNumberOfNodesInParallel
```
int getNumberOfNodesInParallel()
```
    Returns the number of nodes in parallel used by the job since the beginning of its execution
    
    Returns:
    
    number of nodes in parallel used by the job
  - getTotalNumberOfTasks
```
int getTotalNumberOfTasks()
```
    Returns the number of tasks managed by the Job.
    
    Returns:
    
    the number of tasks managed by the Job. The number should correspond to the sum of tasks which are grouped in pending, running and finished.
  - getNumberOfFinishedTasks
```
int getNumberOfFinishedTasks()
```
    Returns the number of tasks managed by the Job which are finished.
    
    Returns:
    
    the number of tasks managed by the Job which are finished.
  - getNumberOfPendingTasks
```
int getNumberOfPendingTasks()
```
    Returns the number of tasks managed by the Job which are pending.
    
    Returns:
    
    the number of tasks managed by the Job which are pending.
  - getNumberOfRunningTasks
```
int getNumberOfRunningTasks()
```
    Returns the number of tasks managed by the Job which are running.
    
    Returns:
    
    the number of tasks managed by the Job which are running.
  - getNumberOfFailedTasks
```
int getNumberOfFailedTasks()
```
    Returns the number of tasks managed by the Job that are in a failed state due to a resource failure.
    
    Returns:
    
    the number of tasks managed by the Job that are in a failed state due to a resource failure.
  - getNumberOfFaultyTasks
```
int getNumberOfFaultyTasks()
```
    Returns the number of tasks managed by the Job that are in a faulty state.
    
    Returns:
    
    the number of tasks managed by the Job that are in a faulty state due to a task fault (exception or return code).
  - getNumberOfInErrorTasks
```
int getNumberOfInErrorTasks()
```
    Returns the number of tasks managed by the Job that are in an in-error state.
    
    Returns:
    
    the number of tasks managed by the Job that are in an in-error state because of faulty tasks that were configured to suspend on error.
  - getPriority
```
JobPriority getPriority()
```
    Returns the priority of the Job.
    
    Returns:
    
    the priority of the Job.
  - getStatus
```
JobStatus getStatus()
```
    Return the status of the job.
    
    Returns:
    
    the status of the job.
  - isToBeRemoved
```
boolean isToBeRemoved()
```
    Returns a boolean that indicates whether the job is marked for removal or not.
    
    Returns:
    
    a boolean that indicates whether the job is marked for removal or not.
  - getScheduledTimeForRemoval
```
long getScheduledTimeForRemoval()
```
    Returns the scheduled time for removal. If none is set, returns 0.
    
    Returns:
    
    the time at which the Job is to be removed.
  - getGenericInformation
```
Map<String,String> getGenericInformation()
```
    Returns the generic information Map
    
    Returns:
    
    generic information Map
  - getVariables
```
Map<String,String> getVariables()
```
    Returns the variables Map
    
    Returns:
    
    variables Map
  - getDetailedVariables
```
Map<String,JobVariable> getDetailedVariables()
```
    Returns the variables Map with full definition
    
    Returns:
    
    variables Map
  - getVisualizationConnectionStrings
```
Map<String,String> getVisualizationConnectionStrings()
```
    Return a map of visualization connection strings key: task name value: connection string
    
    Returns:
    
    a map of connection strings
  - setVisualizationConnectionStrings
```
void setVisualizationConnectionStrings(Map<String,String> connectionStrings)
```
    Sets the visualization connection string map
    
    Parameters:
    
    connectionStrings -
  - getVisualizationIcons
```
Map<String,String> getVisualizationIcons()
```
    Return a map of visualization icons key: task name value: icon associated with the task
    
    Returns:
    
    a map of task icons
  - setVisualizationIcons
```
void setVisualizationIcons(Map<String,String> visualizationIcons)
```
    Sets the visualization icons
    
    Parameters:
    
    visualizationIcons -
  - getAttachedServices
```
Map<Integer,Boolean> getAttachedServices()
```
    Returns a map of attached PSA services {ServiceId, EnableActions}
    
    Returns:
    
    a map of psa service
  - getExternalEndpointUrls
```
Map<String,ExternalEndpoint> getExternalEndpointUrls()
```
    Returns a set of external endpoint urls
    
    Returns:
    
    a set of external endpoint urls
  - getSignals
```
Set<String> getSignals()
```
    Returns the set of signals used by the job
    
    Returns:
    
    signals set
  - setSignals
```
void setSignals(Set<String> signals)
```
    Sets the set of job signals
  - getDetailedSignals
```
Map<String,Map<String,JobVariable>> getDetailedSignals()
```
    Returns the map of signals and input variables
    
    Returns:
    
    signals map
  - setDetailedSignals
```
void setDetailedSignals(Map<String,Map<String,JobVariable>> detailedSignals)
```
    Sets the map of job signals and input variables
  - getPreciousTasks
```
List<String> getPreciousTasks()
```
    Return the list of tasks names with precious results
    
    Returns:
    
    list of task names
  - isResultMapPresent
```
boolean isResultMapPresent()
```
    Return true if a non-empty result map is attached to this job
    
    Returns:
    
    non-empty result map test
  - getParentId
```
Long getParentId()
```
    Return the parent id of the job
    
    Returns:
    
    parent id of the job, or null if the job has no parent
  - getStartAt
```
Long getStartAt()
```
    Return the scheduled time of the job, defined by the generic information START_AT
    
    Returns:
    
    scheduled time of the job of the job, or null it is not defined
  - getChildrenCount
```
int getChildrenCount()
```
    Return the number of children jobs
    
    Returns:
    
    number of children jobs

Interface JobInfo

Method Summary

Method Detail

getJobId

getJobOwner

getTenant

getDomain

getProjectName

getDescription

getBucketName

getLabel

getSubmissionMode

getFinishedTime

getRemovedTime

getStartTime

isStarted

getInErrorTime

getSubmittedTime

getLastUpdatedTime

getCumulatedCoreTime

getNumberOfNodes

getNumberOfNodesInParallel

getTotalNumberOfTasks

getNumberOfFinishedTasks

getNumberOfPendingTasks

getNumberOfRunningTasks

getNumberOfFailedTasks

getNumberOfFaultyTasks

getNumberOfInErrorTasks

getPriority

getStatus

isToBeRemoved

getScheduledTimeForRemoval

getGenericInformation

getVariables

getDetailedVariables

getVisualizationConnectionStrings

setVisualizationConnectionStrings

getVisualizationIcons

setVisualizationIcons

getAttachedServices

getExternalEndpointUrls

getSignals

setSignals

getDetailedSignals

setDetailedSignals

getPreciousTasks

isResultMapPresent

getParentId

getStartAt

getChildrenCount