com.ibm.optim.oaas.client.job.model

Interface JobLogItem

public interface JobLogItem

Class representing an item in the log for a job.

Method Summary

Methods

Modifier and Type	Method and Description
List<JobLogRecord>	getEngineLogRecords() Gets the optimization engine log records associated with the job.
String	getJobId() Gets the ID of the associated job.
long	getSeqid() Sequence ID of the item in the job log.
boolean	missing() Indicates if the log item is missing from the sequence when accessing the sequence in continuous mode.
boolean	stop() Indicates that the log item signals the end of the log item sequence when accessing the sequence in continuous mode.

Method Detail

getJobId

String getJobId()

Gets the ID of the associated job.

Returns:

The job ID.

getSeqid

long getSeqid()

Sequence ID of the item in the job log. Each log item is given a sequence number starting at 0 for each job.

Returns:

The log item sequence ID.

missing

boolean missing()

Indicates if the log item is missing from the sequence when accessing the sequence in continuous mode. A log item is missing if a later log item is available but this one was not stored. A log item can be missing when there was an unexpected delay in storing the log item or if there was an issue in the infrastructure.

Returns:

the missing flag

See Also:

JobClient.getJobLogItems(String, long, boolean)

stop

boolean stop()

Indicates that the log item signals the end of the log item sequence when accessing the sequence in continuous mode. Getting the next log items should not be attempted. If the flag is true, it also guarantee that the job has ended.

Returns:

the stop flag

See Also:

JobClient.getJobLogItems(String, long, boolean)

getEngineLogRecords

List<JobLogRecord> getEngineLogRecords()

Gets the optimization engine log records associated with the job.

Returns:

A list of log records from the optimization engine execution.