de.larssh.jes

Class Job

java.lang.Object

de.larssh.jes.Job

public class Job
extends Object

Value object containing a jobs status information. Depending on the objects creating code not all fields are present.

Two Job objects are equal if their IDs are equal. Therefore two objects with the same ID, but different job status (e.g. one older and one up-to-date object) are still equal!

Constructor Summary

Constructors

Constructor and Description
Job(String jobId, String name, JobStatus status, String owner) This constructor creates a Job in its simplest form.
Job(String jobId, String name, JobStatus status, String owner, Optional<String> jesClass, OptionalInt resultCode, Optional<String> abendCode, JobFlag... flags) This constructor creates a Job allowing to set any field.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
JobOutput	createOutput(int index, String outputName, int length, Optional<String> step, Optional<String> procedureStep, Optional<String> outputClass) Creates a JobOutput and adds it to the list of job outputs.
boolean	equals(Object o)
Optional<String>	getAbendCode() The jobs abend code This field can be present for JobStatus.OUTPUT (and JobStatus.ALL) only.
Set<JobFlag>	getFlags() The jobs flags
String	getId() The jobs ID, must not be empty
Optional<String>	getJesClass() The jobs JES spool class
String	getName() The jobs name Depending on the objects creating code this might be a filter value, eventually containing JesClient.FILTER_WILDCARD.
Optional<JobOutput>	getOutput(String name) Returns the job output details referenced by name or Optional.empty() if no such job output exists.
List<JobOutput>	getOutputs() List of job output details Can be filled by createOutput(int, String, int, Optional, Optional, Optional) and must be empty for status other than JobStatus.OUTPUT (and JobStatus.ALL).
String	getOwner() The jobs owner Depending on the objects creating code this might be a filter value, eventually containing JesClient.FILTER_WILDCARD.
OptionalInt	getResultCode() The jobs result code This field can be present for JobStatus.OUTPUT (and JobStatus.ALL) only.
JobStatus	getStatus() The jobs status
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Job

public Job(String jobId,
           String name,
           JobStatus status,
           String owner)

This constructor creates a Job in its simplest form. String parameters are trimmed and converted to upper case.

Parameters:

jobId - the jobs ID, must not be empty

name - the jobs name or a name filter value

status - the jobs status or JobStatus.ALL

owner - the jobs owner or an owner filter value

Throws:

JobFieldInconsistentException - on inconsistent field value

Job

public Job(String jobId,
           String name,
           JobStatus status,
           String owner,
           Optional<String> jesClass,
           OptionalInt resultCode,
           Optional<String> abendCode,
           JobFlag... flags)

This constructor creates a Job allowing to set any field. String parameters are trimmed and converted to upper case.

Parameters:

jobId - the jobs ID, must not be empty

name - the jobs name or a name filter value

status - the jobs status or JobStatus.ALL

owner - the jobs owner or an owner filter value

jesClass - the jobs JES class

resultCode - the jobs result code, when held (finished)

abendCode - the jobs abend code, when held (finished)

flags - the jobs flags

Throws:

JobFieldInconsistentException - on inconsistent field value

Method Detail

createOutput

public JobOutput createOutput(int index,
                              String outputName,
                              int length,
                              Optional<String> step,
                              Optional<String> procedureStep,
                              Optional<String> outputClass)

Creates a JobOutput and adds it to the list of job outputs. Creating of job outputs for status other than JobStatus.OUTPUT (and JobStatus.ALL) is prohibited. String parameters are trimmed and converted to upper case.

Parameters:

index - the job outputs index inside the jobs list of outputs (starting at 1)

outputName - the job outputs data division name

length - the job outputs content length

step - the job outputs step name

procedureStep - the job outputs procedure step name

outputClass - the output class

Returns:

created job output

Throws:

JobFieldInconsistentException - on inconsistent field value

getOutput

public Optional<JobOutput> getOutput(String name)

Returns the job output details referenced by name or Optional.empty() if no such job output exists.

Parameters:

name - job output name to search for

Returns:

job output details referenced by name or Optional.empty() if no such job output exists

getOutputs

public List<JobOutput> getOutputs()

List of job output details

Can be filled by createOutput(int, String, int, Optional, Optional, Optional) and must be empty for status other than JobStatus.OUTPUT (and JobStatus.ALL).

Returns:

list of job output details

getId

public String getId()

The jobs ID, must not be empty

Returns:

job id

getName

public String getName()

The jobs name

Depending on the objects creating code this might be a filter value, eventually containing JesClient.FILTER_WILDCARD.

Returns:

job name

getStatus

public JobStatus getStatus()

The jobs status

Returns:

job status

getOwner

public String getOwner()

The jobs owner

Depending on the objects creating code this might be a filter value, eventually containing JesClient.FILTER_WILDCARD.

Returns:

job owner

getJesClass

public Optional<String> getJesClass()

The jobs JES spool class

Returns:

job class

getResultCode

public OptionalInt getResultCode()

The jobs result code

This field can be present for JobStatus.OUTPUT (and JobStatus.ALL) only. It cannot be present as long as abendCode is present.

Returns:

result code

getAbendCode

public Optional<String> getAbendCode()

The jobs abend code

This field can be present for JobStatus.OUTPUT (and JobStatus.ALL) only. It cannot be present as long as resultCode is present.

Returns:

abend code

getFlags

public Set<JobFlag> getFlags()

The jobs flags

Returns:

flags

toString

@NonNull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
                           Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object