com.ibm.etools.iseries.comm.filters
Class ISeriesSplfFilterString

java.lang.Object
  com.ibm.etools.iseries.comm.filters.ISeriesAbstractFilterString
      com.ibm.etools.iseries.comm.filters.ISeriesSplfFilterString

public class ISeriesSplfFilterString
extends ISeriesAbstractFilterString

A class representing an AS/400 Spool File filter string. This is a name pattern for returning lists of spool files when used as input to the subsystem class. Valid generic names are names with one or two asterisks anywhere in the name, as in: ABC* or *ABC or A*C *ABC* or *A*C or A*C* To get the actual filter string back from objects of this class, just call toString().

Field Summary

static String	ALL
static String	copyright

Fields inherited from class com.ibm.etools.iseries.comm.filters.ISeriesAbstractFilterString

Copyright, QUOTE, WILDCARD

Constructor Summary

ISeriesSplfFilterString()
Constructor to use when there is no existing filter string.

ISeriesSplfFilterString(String input)
Constructor to use when filter string already exists.

Method Summary

String	getFileName() Return the file name part of this filter string.
String	getForm() Return the form part of this filter string.
String	getJobName() Return the job name part of this filter string.
String	getJobNumber() Return the job name part of this filter string.
String	getJobUser() Return the job name part of this filter string.
String	getOutqLibrary() Return the outq library part of this filter string.
String	getOutqName() Return the outq name part of this filter string.
String	getUser() Return the user name part of this filter string.
String	getUserData() Return the user-data name part of this filter string.
boolean	isGeneric() Returns true if current filter represents a generic name versus a scalar name.
boolean	isMultiGeneric() Returns true if current filter represents a generic name that has more than one generic name part.
void	setFile(String obj) Set the file name part of this filter string.
void	setJobName(String obj) Set the name part of this filter string.
void	setJobNumber(String obj) Set the number part of this filter string.
void	setJobUser(String obj) Set the name part of this filter string.
void	setUser(String obj) Set the user name part of this filter string.
String	toString() Convert this filter into a filter string.

Methods inherited from class com.ibm.etools.iseries.comm.filters.ISeriesAbstractFilterString

addQuotes, clone, countHostOccurrencesOf, countOccurrencesOf, createFilterStringObject, equals, hashCode, hostIndexOf, hostIndexOf, isGenericLibraryName, isGenericName, isQuoted, stripQuotes, verifyGenericName, verifyGenericNameAdvanced, verifyGenericNameAdvancedQuoted, verifyGenericNameQuoted

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

Constructor Detail

ISeriesSplfFilterString

public ISeriesSplfFilterString()

Constructor to use when there is no existing filter string.

ISeriesSplfFilterString

public ISeriesSplfFilterString(String input)

Constructor to use when filter string already exists.

Method Detail

getUser

public String getUser()

Return the user name part of this filter string.

getFileName

public String getFileName()

Return the file name part of this filter string.

getJobName

public String getJobName()

Return the job name part of this filter string.

getJobUser

public String getJobUser()

Return the job name part of this filter string.

getJobNumber

public String getJobNumber()

Return the job name part of this filter string.

getOutqName

public String getOutqName()

Return the outq name part of this filter string.

getOutqLibrary

public String getOutqLibrary()

Return the outq library part of this filter string.

getForm

public String getForm()

Return the form part of this filter string.

getUserData

public String getUserData()

Return the user-data name part of this filter string.

setUser

public void setUser(String obj)

Set the user name part of this filter string. This can be simple or generic, where generic is a name containing one or two asterisks anywhere in the name.

setFile

public void setFile(String obj)

Set the file name part of this filter string. This can be simple or generic, where generic is a name containing one or two asterisks anywhere in the name.

setJobName

public void setJobName(String obj)

Set the name part of this filter string. This can be simple or generic, where generic is a name containing one or two asterisks anywhere in the name.

setJobUser

public void setJobUser(String obj)

Set the name part of this filter string. This can be simple or generic, where generic is a name containing one or two asterisks anywhere in the name.

setJobNumber

public void setJobNumber(String obj)

Set the number part of this filter string.

toString

public String toString()

Convert this filter into a filter string.

Specified by:

toString in class ISeriesAbstractFilterString

isGeneric

public boolean isGeneric()

Returns true if current filter represents a generic name versus a scalar name. This is true if either the library or the object names are generic. A valid generic name has one or two asterisks anywhere in the name.

Specified by:

isGeneric in class ISeriesAbstractFilterString

isMultiGeneric

public boolean isMultiGeneric()

Returns true if current filter represents a generic name that has more than one generic name part. For example, a multi-generic filter might ask to list all objects that start with A in all libraries that start with B. This returns true if the library name is generic, but not if it is *CURLIB.

Specified by:

isMultiGeneric in class ISeriesAbstractFilterString