com.ibm.as400.resource
Class RJobList

java.lang.Object
  com.ibm.as400.resource.ResourceList
      com.ibm.as400.resource.BufferedResourceList
          com.ibm.as400.resource.SystemResourceList
              com.ibm.as400.resource.RJobList

All Implemented Interfaces:

Serializable

Deprecated. Use JobList instead, as this package may be removed in the future.

public class RJobList
extends SystemResourceList

The RJobList class represents a list of server jobs.

The following selection IDs are supported:

• JOB_NAME
• JOB_NUMBER
• JOB_TYPE
• PRIMARY_JOB_STATUSES
• USER_NAME

Use one or more of these selection IDs with getSelectionValue() and setSelectionValue() to access the selection values for an RJobList.

The following sort IDs are supported:

• RJob.JOB_NAME
• RJob.USER_NAME
• RJob.JOB_NUMBER
• RJob.JOB_TYPE
• RJob.JOB_SUBTYPE

Use one or more of these sort IDs with getSortValue() and setSortValue() to access the sort values for an RJobList.

RJobList objects generate RJob objects.

// Create an RJobList object to represent a list of jobs.
AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
RJobList jobList = new RJobList(system);


// Set the selection so that only active jobs with the name
// "QZDASOINIT" are included in the list.
jobList.setSelectionValue(RJobList.PRIMARY_JOB_STATUSES, new String[] { RJob.JOB_STATUS_ACTIVE });
jobList.setSelectionValue(RJobList.JOB_NAME, "QZDASOINIT");


// Set the sort value so that the list is sorted by
// user name and job type.
Object[] sortValue = new Object[] { RJob.USER_NAME, RJob.JOB_TYPE };
jobList.setSortValue(sortValue);


// Open the list and wait for it to complete.
jobList.open();
jobList.waitForComplete();


// Read and print the job numbers for the jobs in the list.
long numberOfJobs = jobList.getListLength();
for(long i = 0; i < numberOfJobs; ++i)
{
    RJob job = (RJob)jobList.resourceAt(i);
    System.out.println(job.getAttributeValue(RJob.JOB_NUMBER));
}


// Close the list.
jobList.close();

See Also:

RJob, Serialized Form

Field Summary

Modifier and Type	Field and Description
static String	ALL Deprecated. Constant indicating that all jobs are returned.
static String	BLANK Deprecated. Constant indicating that a blank value is used.
static String	CURRENT Deprecated. Constant indicating that the current value is used.
static String	JOB_NAME Deprecated. Selection ID for job name.
static String	JOB_NUMBER Deprecated. Selection ID for job number.
static String	JOB_TYPE Deprecated. Selection ID for job type.
static String	PRIMARY_JOB_STATUSES Deprecated. Selection ID for jobs on primary job statuses.
static String	USER_NAME Deprecated. Selection ID for user name.

Constructor and Description

RJobList()
Deprecated. Constructs an RJobList object.

RJobList(AS400 system)
Deprecated. Constructs an RJobList object.

Method Summary

Modifier and Type	Method and Description
protected void	establishConnection() Deprecated. Establishes the connection to the system.

Methods inherited from class com.ibm.as400.resource.SystemResourceList

close, isBidiEnabled, isResourceAvailable, open, refreshContents, refreshStatus, resourceAt, setSelectionValue, waitForComplete, waitForResource

Methods inherited from class com.ibm.as400.resource.BufferedResourceList

fireResourceAdded, getNumberOfPages, getPageSize, setNumberOfPages, setPageSize

Methods inherited from class com.ibm.as400.resource.ResourceList

addActiveStatusListener, addPropertyChangeListener, addResourceListListener, addVetoableChangeListener, arePropertiesFrozen, fireBusy, fireIdle, fireLengthChanged, fireListClosed, fireListCompleted, fireListInError, fireListOpened, firePropertyChange, fireVetoableChange, freezeProperties, getAttributeMetaData, getAttributeMetaData, getListLength, getPresentation, getSelectionMetaData, getSelectionMetaData, getSelectionValue, getSelectionValue, getSortMetaData, getSortMetaData, getSortOrder, getSortValue, getSystem, isComplete, isConnectionEstablished, isInError, isOpen, removeActiveStatusListener, removePropertyChangeListener, removeResourceListListener, removeVetoableChangeListener, resources, setAttributeMetaData, setPresentation, setSelectionValue, setSortOrder, setSortValue, setSystem, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final String ALL

Deprecated.

Constant indicating that all jobs are returned.

See Also:

Constant Field Values

BLANK

public static final String BLANK

Deprecated.

Constant indicating that a blank value is used.

See Also:

Constant Field Values

CURRENT

public static final String CURRENT

Deprecated.

Constant indicating that the current value is used.

See Also:

Constant Field Values

JOB_NAME

public static final String JOB_NAME

Deprecated.

Selection ID for job name. This identifies a String selection, which represents a specific job name. Possible values are:

• "*" - Only the job that this program is running in.
• CURRENT - All jobs with the current job's name.
• ALL - All job names.
• A job name.

The default is ALL.

See Also:

Constant Field Values

JOB_NUMBER

public static final String JOB_NUMBER

Deprecated.

Selection ID for job number. This identifies a String selection, which represents a specific job number. Possible values are:

• ALL - All job numbers.
• A job number.

The default is ALL.

See Also:

Constant Field Values

JOB_TYPE

public static final String JOB_TYPE

Deprecated.

Selection ID for job type. This identifies a String selection, which represents the type of job to be listed. Possible values are:

• ALL - All job types.
• RJob.JOB_TYPE_AUTOSTART - The job is an autostart job.
• RJob.JOB_TYPE_BATCH - The job is a batch job.
• RJob.JOB_TYPE_INTERACTIVE - The job is an interactive job.
• RJob.JOB_TYPE_SUBSYSTEM_MONITOR - The job is a subsystem monitor job.
• RJob.JOB_TYPE_SPOOLED_READER - The job is a spooled reader job.
• RJob.JOB_TYPE_SYSTEM - The job is a system job.
• RJob.JOB_TYPE_SPOOLED_WRITER - The job is a spooled writer job.
• RJob.JOB_TYPE_SCPF_SYSTEM - The job is the SCPF system job.

The default is ALL.

See Also:

Constant Field Values

PRIMARY_JOB_STATUSES

public static final String PRIMARY_JOB_STATUSES

Deprecated.

Selection ID for jobs on primary job statuses. This identifies a String array selection, which represents the primary statuses of the jobs to be included in the list. Possible values for each element of the array are:

• RJob.JOB_STATUS_ACTIVE - The job is active.
• RJob.JOB_STATUS_JOBQ - The job is currently on a job queue.
• RJob.JOB_STATUS_OUTQ - The job has completed running, but still has output on an output queue.

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

Deprecated.

Selection ID for user name. This identifies a String selection, which represents a specific user profile name. Possible values are:

• CURRENT - All jobs with the current job's user profile.
• ALL - All jobs regardless of user name.
• A user profile name.

The default is ALL.

See Also:

Constant Field Values

Constructor Detail

RJobList

public RJobList()

Deprecated.

Constructs an RJobList object.

RJobList

public RJobList(AS400 system)

Deprecated.

Constructs an RJobList object.

Parameters:

system - The system.

Method Detail

establishConnection

protected void establishConnection()
                            throws ResourceException

Deprecated.

Establishes the connection to the system.

The method is called by the resource framework automatically when the connection needs to be established.

Overrides:

establishConnection in class ResourceList

Throws:

ResourceException - If an error occurs.