Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

support OSPL0400 for SpooledFileOpenList #29

Merged
merged 6 commits into from
Jun 8, 2023
Merged

support OSPL0400 for SpooledFileOpenList #29

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1be0cfe
support OSPL0400 for SpooledFileOpenList
jwoehr Apr 10, 2023
83285b9
Small stylistic change to `SpooledFileListItem` constructor
ThePrez Apr 27, 2023
13500c6
Add `TODO` to replace numeric literal comparisons
ThePrez Apr 27, 2023
7a6be8e
Merge branch 'main' into ospl_0400
jwoehr May 13, 2023
3ccd9da
Merge branch 'main' into ospl_0400
jwoehr Jun 4, 2023
ad2059c
Merge branch 'main' of github.com:IBM/JTOpen into ospl_0400
jwoehr Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
51 changes: 29 additions & 22 deletions src/main/java/com/ibm/as400/access/list/SpooledFileListItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,13 +267,20 @@ Constant indicating the spooled file is pending (waiting) to be printed.
format_ = SpooledFileOpenList.FORMAT_0300;
}

SpooledFileListItem(String jobName, String jobUser, String jobNumber, String name, int number, int status, String dateOpened, String timeOpened, String schedule, String jobSystemName, String userData, String formType, String outputQueueName, String outputQueueLibrary, int asp, int size, int sizeMultiplier, int totalPages, int copiesLeftToPrint, String priority, int ippJobIdentifier, boolean isOSPL400) {
this(jobName, jobUser, jobNumber, name, number, status, dateOpened, timeOpened, schedule, jobSystemName, userData, formType, outputQueueName, outputQueueLibrary, asp, size, sizeMultiplier, totalPages, copiesLeftToPrint, priority, ippJobIdentifier);
if (isOSPL400) {
ThePrez marked this conversation as resolved.
Show resolved Hide resolved
format_ = SpooledFileOpenList.FORMAT_0400;
}
}

/**
Returns the auxiliary storage pool (ASP) in which the spooled file resides. Possible values are:
<ul>
<li>1 - The system auxiliary storage pool (*SYSTEM).
<li>2-255 - The number of the auxiliary storage pool.
</ul>
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The auxiliary storage pool.
**/
public int getASP()
Expand All @@ -294,7 +301,7 @@ public int getCopiesLeftToPrint()

/**
Returns the date and time the spooled file was created.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@see #getDateOpened
@see #getTimeOpened
@return The date and time formatted into a java.util.Date object.
Expand Down Expand Up @@ -325,7 +332,7 @@ public int getCurrentPage()

/**
Returns the date the spooled file was created.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@see #getCreationDate
@return The date in the format CYYMMDD.
**/
Expand Down Expand Up @@ -363,7 +370,7 @@ public String getFormat()

/**
Returns the type of forms that should be loaded on the printer before this spooled file is printed. This attribute applies to printer device type spooled files only.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The form type.
@see #getDeviceType
**/
Expand Down Expand Up @@ -395,7 +402,7 @@ public byte[] getInternalSpooledFileIdentifier()

/**
Returns the Internet Print Protocol (IPP) job identifier assigned by the system based on the output queue to which the file was added or moved. This value ranges from 1 to 2,147,483,647 and is not guaranteed to be unique for a given output queue. This value will be 0 when retrieved from systems running i5/OS V5R2M0 and earlier.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300},
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400},
@return The IPP job identifier.
**/
public int getIPPJobIdentifier()
Expand All @@ -405,7 +412,7 @@ public int getIPPJobIdentifier()

/**
Returns the name of the job that created the spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The job name.
@see #getJobNumber
@see #getJobUser
Expand All @@ -417,7 +424,7 @@ public String getJobName()

/**
Returns the number of the job that created the spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The job number.
@see #getJobName
@see #getJobUser
Expand All @@ -429,7 +436,7 @@ public String getJobNumber()

/**
Returns the name of the system where the job that created the spooled file ran.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The system name.
**/
public String getJobSystemName()
Expand All @@ -439,7 +446,7 @@ public String getJobSystemName()

/**
Returns the user of the job that created the spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The user name.
@see #getJobName
@see #getJobNumber
Expand All @@ -451,7 +458,7 @@ public String getJobUser()

/**
Returns the name of the spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The spooled file name.
**/
public String getName()
Expand All @@ -461,7 +468,7 @@ public String getName()

/**
Returns the number of the spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The spooled file number.
**/
public int getNumber()
Expand All @@ -471,7 +478,7 @@ public int getNumber()

/**
Returns the fully-qualified integrated file system path of the output queue in which the spooled file is located.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The output queue.
@see #getOutputQueueName
@see #getOutputQueueLibrary
Expand All @@ -483,7 +490,7 @@ public String getOutputQueue()

/**
Returns the library of the output queue in which the spooled file is located.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The library.
@see #getOutputQueue
**/
Expand All @@ -494,7 +501,7 @@ public String getOutputQueueLibrary()

/**
Returns the name of the output queue in which the spooled file is located.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The output queue name.
@see #getOutputQueue
**/
Expand Down Expand Up @@ -538,7 +545,7 @@ public String getPrinterName()

/**
Returns the priority of the spooled file. The priority ranges from 1 (highest) to 9 (lowest).
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The priority.
**/
public String getPriority()
Expand All @@ -553,7 +560,7 @@ public String getPriority()
<li>{@link #SCHEDULE_FILE_END SCHEDULE_FILE_END}
<li>{@link #SCHEDULE_JOB_END SCHEDULE_JOB_END}
</ul>
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The schedule.
**/
public String getSchedule()
Expand All @@ -567,7 +574,7 @@ public String getSchedule()

/**
Returns the spooled file size in bytes. The size of the spooled file is the data stream size, plus the spooled file's attributes, plus the overhead storage used to store the spooled file's data stream.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The size.
**/
public long getSize()
Expand All @@ -592,7 +599,7 @@ public long getSize()
<li>{@link #STATUS_SENDING STATUS_SENDING}
<li>{@link #STATUS_DEFERRED STATUS_DEFERRED}
</ul>
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The status.
**/
public String getStatus()
Expand All @@ -616,7 +623,7 @@ public String getStatus()

/**
Returns the time the spooled file was created.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100} (i5/OS V5R2M0 and higher), {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@see #getCreationDate
@return The time in the format HHMMSS.
**/
Expand All @@ -627,7 +634,7 @@ public String getTimeOpened()

/**
Returns the total number of pages or number of records for this spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The number of pages.
**/
public int getTotalPages()
Expand All @@ -637,7 +644,7 @@ public int getTotalPages()

/**
Returns the 10 characters of user-specified data that describe the spooled file.
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}
<p>Available in format: {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0100 FORMAT_0100}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0200 FORMAT_0200}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0300 FORMAT_0300}, {@link com.ibm.as400.access.list.SpooledFileOpenList#FORMAT_0400 FORMAT_0400}
@return The user data.
**/
public String getUserData()
Expand All @@ -646,7 +653,7 @@ public String getUserData()
}

// Helper method used to convert the integer status returned by one API format to the String status returned by the other API format.
private static final String mapStatus(int status)
private static String mapStatus(int status)
{
switch (status)
{
Expand Down