Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.services.qsys.jobs
Class QSYSHostJob

java.lang.Object
  extended by com.ibm.etools.iseries.services.qsys.jobs.QSYSHostJob
All Implemented Interfaces:
IQSYSJob
Direct Known Subclasses:
QSYSRemoteJob

public class QSYSHostJob
extends Object
implements IQSYSJob

Class representing an IBM i job.


Field Summary
static String copyright
           
 
Constructor Summary
QSYSHostJob()
           
 
Method Summary
 void clearCachedProperties()
          Clear cached properties
 boolean equals(Object obj)
           
 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
 int hashCode()
           
 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
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

copyright

public static String copyright
Constructor Detail

QSYSHostJob

public QSYSHostJob()
Method Detail

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getAbsoluteName

public String getAbsoluteName()
Description copied from interface: IQSYSJob
Return the absolute job name.

Same as getFullJobName().

Specified by:
getAbsoluteName in interface IQSYSJob
Returns:
jobNumber/userName/jobName

getDateEntered

public Date getDateEntered()
Description copied from interface: IQSYSJob
Return the status for this job.

Specified by:
getDateEntered in interface IQSYSJob

getFullJobName

public String getFullJobName()
Description copied from interface: IQSYSJob
Return the fully qualified iSeries job name in the format: jobNumber/userName/jobName

Same as getAbsoluteName().

Specified by:
getFullJobName in interface IQSYSJob

getJobName

public String getJobName()
Description copied from interface: IQSYSJob
Return the job name

Specified by:
getJobName in interface IQSYSJob

getJobNumber

public String getJobNumber()
Description copied from interface: IQSYSJob
Return the job number

Specified by:
getJobNumber in interface IQSYSJob

getJobType

public String getJobType()
Description copied from interface: IQSYSJob
Return the type of job.

Specified by:
getJobType in interface IQSYSJob

getStatus

public String getStatus()
Description copied from interface: IQSYSJob
Return the status for this job.

Specified by:
getStatus in interface IQSYSJob

getUserName

public String getUserName()
Description copied from interface: IQSYSJob
Return the job user name

Specified by:
getUserName in interface IQSYSJob

setDateEntered

public void setDateEntered(Date date)
Description copied from interface: IQSYSJob
Set the Date entered for this job.

Specified by:
setDateEntered in interface IQSYSJob

setJobName

public void setJobName(String name)
Description copied from interface: IQSYSJob
Set the job name

Specified by:
setJobName in interface IQSYSJob

setJobNumber

public void setJobNumber(String number)
Description copied from interface: IQSYSJob
Set the job number

Specified by:
setJobNumber in interface IQSYSJob

setJobType

public void setJobType(String type)
Description copied from interface: IQSYSJob
Set the job type.

Specified by:
setJobType in interface IQSYSJob

setStatus

public void setStatus(String status)
Description copied from interface: IQSYSJob
Set the status for this job.

Specified by:
setStatus in interface IQSYSJob

setUserName

public void setUserName(String user)
Description copied from interface: IQSYSJob
Set the job user name

Specified by:
setUserName in interface IQSYSJob

getSubsystem

public String getSubsystem()
Description copied from interface: IQSYSJob
Return the subsystem for this job.

Specified by:
getSubsystem in interface IQSYSJob

setSubsystem

public void setSubsystem(String subsystem)
Description copied from interface: IQSYSJob
Set the subsystem for this job.

Specified by:
setSubsystem in interface IQSYSJob

getCurrentUser

public String getCurrentUser()
Description copied from interface: IQSYSJob
Return the user profile for this job

Specified by:
getCurrentUser in interface IQSYSJob

setCurrentUser

public void setCurrentUser(String userProfile)
Description copied from interface: IQSYSJob
Set the user profile for this job

Specified by:
setCurrentUser in interface IQSYSJob

toString

public String toString()
Overrides:
toString in class Object

getInternationalProperties

public IQSYSJobInternationalProperties getInternationalProperties()
                                                           throws SystemMessageException
Description copied from interface: IQSYSJob
Get the international properties for this job

Specified by:
getInternationalProperties in interface IQSYSJob
Throws:
SystemMessageException

setInternationalProperties

public void setInternationalProperties(IQSYSJobInternationalProperties properties)
Description copied from interface: IQSYSJob
Set the international properties for this job

Specified by:
setInternationalProperties in interface IQSYSJob

getDefinitionProperties

public IQSYSJobDefinitionProperties getDefinitionProperties()
                                                     throws SystemMessageException
Description copied from interface: IQSYSJob
Get the definition properties for this job

Specified by:
getDefinitionProperties in interface IQSYSJob
Throws:
SystemMessageException

getRunProperties

public IQSYSJobRunProperties getRunProperties()
                                       throws SystemMessageException
Description copied from interface: IQSYSJob
Get the run properties for this job

Specified by:
getRunProperties in interface IQSYSJob
Throws:
SystemMessageException

getStatusProperties

public IQSYSJobStatusProperties getStatusProperties()
                                             throws SystemMessageException
Description copied from interface: IQSYSJob
Get the status properties for this job

Specified by:
getStatusProperties in interface IQSYSJob
Throws:
SystemMessageException

setDefinitionProperties

public void setDefinitionProperties(IQSYSJobDefinitionProperties properties)
Description copied from interface: IQSYSJob
Set the definition properties for this job

Specified by:
setDefinitionProperties in interface IQSYSJob

setRunProperties

public void setRunProperties(IQSYSJobRunProperties properties)
Description copied from interface: IQSYSJob
Set the run properties for this job

Specified by:
setRunProperties in interface IQSYSJob

setStatusProperties

public void setStatusProperties(IQSYSJobStatusProperties properties)
Description copied from interface: IQSYSJob
Set the status properties for this job

Specified by:
setStatusProperties in interface IQSYSJob

clearCachedProperties

public void clearCachedProperties()
Description copied from interface: IQSYSJob
Clear cached properties

Specified by:
clearCachedProperties in interface IQSYSJob

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.