com.ibm.etools.iseries.services.qsys.api
Interface IQSYSJob

All Known Implementing Classes:

QSYSHostJob, QSYSRemoteJob, QSYSRemoteRSEServerJob

public interface IQSYSJob

Interface representing an IBM i operating system job.

Field Summary

static String

copyright

Method Summary

void	clearCachedProperties() Clear cached properties
String	getAbsoluteName() Return the absolute job name.
String	getCurrentUser() Return the user profile for this job
Date	getDateEntered() Return the status for this job.
IQSYSJobDefinitionProperties	getDefinitionProperties() Get the definition properties for this job
String	getFullJobName() Return the fully qualified iSeries job name in the format: jobNumber/userName/jobName
IQSYSJobInternationalProperties	getInternationalProperties() Get the international properties for this job
String	getJobName() Return the job name
String	getJobNumber() Return the job number
String	getJobType() Return the type of job.
IQSYSJobRunProperties	getRunProperties() Get the run properties for this job
String	getStatus() Return the status for this job.
IQSYSJobStatusProperties	getStatusProperties() Get the status properties for this job
String	getSubsystem() Return the subsystem for this job.
String	getUserName() Return the job user name
void	setCurrentUser(String userProfile) Set the user profile for this job
void	setDateEntered(Date date) Set the Date entered for this job.
void	setDefinitionProperties(IQSYSJobDefinitionProperties properties) Set the definition properties for this job
void	setInternationalProperties(IQSYSJobInternationalProperties properties) Set the international properties for this job
void	setJobName(String name) Set the job name
void	setJobNumber(String number) Set the job number
void	setJobType(String type) Set the job type.
void	setRunProperties(IQSYSJobRunProperties properties) Set the run properties for this job
void	setStatus(String status) Set the status for this job.
void	setStatusProperties(IQSYSJobStatusProperties properties) Set the status properties for this job
void	setSubsystem(String subsystem) Set the subsystem for this job.
void	setUserName(String user) Set the job user name

Field Detail

copyright

static final String copyright

See Also:

Constant Field Values

Method Detail

getAbsoluteName

String getAbsoluteName()

Return the absolute job name.

Same as getFullJobName().

Returns:

jobNumber/userName/jobName

getJobType

String getJobType()

Return the type of job.

getFullJobName

String getFullJobName()

Return the fully qualified iSeries job name in the format: jobNumber/userName/jobName

Same as getAbsoluteName().

getJobNumber

String getJobNumber()

Return the job number

getUserName

String getUserName()

Return the job user name

getJobName

String getJobName()

Return the job name

getStatus

String getStatus()

Return the status for this job.

getDateEntered

Date getDateEntered()

Return the status for this job.

getSubsystem

String getSubsystem()

Return the subsystem for this job.

getCurrentUser

String getCurrentUser()

Return the user profile for this job

setJobType

void setJobType(String type)

Set the job type.

setJobNumber

void setJobNumber(String number)

Set the job number

setUserName

void setUserName(String user)

Set the job user name

setJobName

void setJobName(String name)

Set the job name

setStatus

void setStatus(String status)

Set the status for this job.

setDateEntered

void setDateEntered(Date date)

Set the Date entered for this job.

setSubsystem

void setSubsystem(String subsystem)

Set the subsystem for this job.

setCurrentUser

void setCurrentUser(String userProfile)

Set the user profile for this job

getInternationalProperties

IQSYSJobInternationalProperties getInternationalProperties()
                                                           throws SystemMessageException

Get the international properties for this job

Throws:

SystemMessageException

setInternationalProperties

void setInternationalProperties(IQSYSJobInternationalProperties properties)

Set the international properties for this job

getRunProperties

IQSYSJobRunProperties getRunProperties()
                                       throws SystemMessageException

Get the run properties for this job

Throws:

SystemMessageException

setRunProperties

void setRunProperties(IQSYSJobRunProperties properties)

Set the run properties for this job

getDefinitionProperties

IQSYSJobDefinitionProperties getDefinitionProperties()
                                                     throws SystemMessageException

Get the definition properties for this job

Throws:

SystemMessageException

setDefinitionProperties

void setDefinitionProperties(IQSYSJobDefinitionProperties properties)

Set the definition properties for this job

getStatusProperties

IQSYSJobStatusProperties getStatusProperties()
                                             throws SystemMessageException

Get the status properties for this job

Throws:

SystemMessageException

setStatusProperties

void setStatusProperties(IQSYSJobStatusProperties properties)

Set the status properties for this job

clearCachedProperties

void clearCachedProperties()

Clear cached properties