Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.subsystems.qsys.jobs
Class QSYSJobSubSystem

java.lang.Object
  extended by SubSystem
      extended by com.ibm.etools.iseries.subsystems.qsys.QSYSAbstractSubSystem
          extended by com.ibm.etools.iseries.subsystems.qsys.jobs.QSYSJobSubSystem
All Implemented Interfaces:
IISeriesSubSystem

public class QSYSJobSubSystem
extends QSYSAbstractSubSystem

Subsystem for accessing remote IBM i jobs.


Field Summary
static String copyright
           
 
Constructor Summary
QSYSJobSubSystem(IHost host, IConnectorService connectorService)
           
 
Method Summary
 boolean endJob(String jobName, boolean immediately)
          End the specified job.
 QSYSJobCacheHandler getCacheHandler()
          Returns cache handler for this subsystem
 IISeriesEditDescriptionsInfo getEditDescriptions()
          Query the edit descriptions for the remote iSeries.
 IISeriesEditMask getEditMask(char editcode, char fillchar, int precision, int decimals)
          Create an edit mask from an edit code
 int getEncodingScheme(int ccsid)
          Query the encoding scheme for the CCSID
 String getEnvironmentVaraible(String variableName)
          Retrieve environment variable
 IQSYSJob getServerJob(IProgressMonitor monitor)
          Get the server job for this service layer
 IISeriesSortSequenceTable getSortSequenceTable(String table, String library, String langID, int ccsid)
          Retrieve a sort sequence table from the iSeries
 String getSystemInfoProperty(String propertyName)
          Retrieve the value of a property which is contained in the environment miners system info child.
 List<String> handleDisplayJobLog(String jobName, String userName, String jobNumber, IProgressMonitor monitor)
          Query the job log of a particular job.
 void initializeSubSystem(IProgressMonitor monitor)
           
 Object[] internalResolveFilterString(String filterString, IProgressMonitor monitor)
           
 Object[] internalResolveFilterStrings(String[] filterStrings, IProgressMonitor monitor)
           
 Object[] listJobs(String filterString, IProgressMonitor monitor)
          List the jobs that match the specified filter string.
 List<ISeriesTCPIPNetworkInterface> listNetworkInterfaces()
           
 void setAllJobProperties(IQSYSJob job, IProgressMonitor monitor)
          Sets all the properties for the specified job.
 void uninitializeSubSystem(IProgressMonitor monitor)
           
 
Methods inherited from class com.ibm.etools.iseries.subsystems.qsys.QSYSAbstractSubSystem
checkIsConnected, checkIsConnected, checkIsConnected, getCmdSubSystem, getObjectSubSystem, processListRetrieveError, verifyConnected
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static String copyright
Constructor Detail

QSYSJobSubSystem

public QSYSJobSubSystem(IHost host,
                        IConnectorService connectorService)
Method Detail

initializeSubSystem

public void initializeSubSystem(IProgressMonitor monitor)

internalResolveFilterStrings

public Object[] internalResolveFilterStrings(String[] filterStrings,
                                             IProgressMonitor monitor)
                                      throws InvocationTargetException,
                                             InterruptedException
Throws:
InvocationTargetException
InterruptedException

internalResolveFilterString

public Object[] internalResolveFilterString(String filterString,
                                            IProgressMonitor monitor)
                                     throws InvocationTargetException,
                                            InterruptedException
Throws:
InvocationTargetException
InterruptedException

listJobs

public Object[] listJobs(String filterString,
                         IProgressMonitor monitor)
                  throws InvocationTargetException,
                         InterruptedException
List the jobs that match the specified filter string.

Throws:
InvocationTargetException
InterruptedException

listNetworkInterfaces

public List<ISeriesTCPIPNetworkInterface> listNetworkInterfaces()
                                                         throws SystemMessageException
Throws:
SystemMessageException

setAllJobProperties

public void setAllJobProperties(IQSYSJob job,
                                IProgressMonitor monitor)
                         throws SystemMessageException
Sets all the properties for the specified job.

Throws:
SystemMessageException

getServerJob

public IQSYSJob getServerJob(IProgressMonitor monitor)
                      throws SystemMessageException
Get the server job for this service layer

Throws:
SystemMessageException

handleDisplayJobLog

public List<String> handleDisplayJobLog(String jobName,
                                        String userName,
                                        String jobNumber,
                                        IProgressMonitor monitor)
                                 throws SystemMessageException
Query the job log of a particular job.

Parameters:
jobName - name of the job
userName - user id of the job
jobNumber - job number
monitor - progress monitor
Returns:
List of the message strings in the job log.
Throws:
SystemMessageException

getEnvironmentVaraible

public String getEnvironmentVaraible(String variableName)
                              throws SystemMessageException
Retrieve environment variable

Throws:
SystemMessageException

getSystemInfoProperty

public String getSystemInfoProperty(String propertyName)
                             throws SystemMessageException
Retrieve the value of a property which is contained in the environment miners system info child. Constants from @link IQSYSSystemValueConstants

Returns:
The String value of the property or "" if the property was not found.
Throws:
SystemMessageException

getSortSequenceTable

public IISeriesSortSequenceTable getSortSequenceTable(String table,
                                                      String library,
                                                      String langID,
                                                      int ccsid)
                                               throws SystemMessageException
Retrieve a sort sequence table from the iSeries

Parameters:
table - The name of the sort sequence table
library - The library where the table resides
langID - The language identifier of the sort sequence table to be used
ccsid - The CCSID in which the table is to be returned
Throws:
SystemMessageException

getEditDescriptions

public IISeriesEditDescriptionsInfo getEditDescriptions()
                                                 throws SystemMessageException
Query the edit descriptions for the remote iSeries.

Returns:
The edit descriptions info instance which contains system values for processing edit codes and the user defined edit codes (edit descriptions) on the iSeries.
Throws:
SystemMessageException

getEditMask

public IISeriesEditMask getEditMask(char editcode,
                                    char fillchar,
                                    int precision,
                                    int decimals)
                             throws SystemMessageException
Create an edit mask from an edit code

Parameters:
table - The name of the sort sequence table
library - The library where the table resides
langID - The language identifier of the sort sequence table to be used
ccsid - The CCSID in which the table is to be returned
Throws:
SystemMessageException

getEncodingScheme

public int getEncodingScheme(int ccsid)
                      throws SystemMessageException
Query the encoding scheme for the CCSID

Parameters:
ccsid - The CCSID to query
Returns:
The encoding scheme for the CCSID
Throws:
SystemMessageException

endJob

public boolean endJob(String jobName,
                      boolean immediately)
               throws SystemMessageException
End the specified job.

Parameters:
jobName - full job name in the format: jobNumber/userName/jobName
immediately - if true is specified, the job will be ended immediately. if false is specified, the job will be ended controlled
Returns:
true, if job is ended successfully
Throws:
SystemMessageException

getCacheHandler

public QSYSJobCacheHandler getCacheHandler()
Returns cache handler for this subsystem


uninitializeSubSystem

public void uninitializeSubSystem(IProgressMonitor monitor)

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.