Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.interfaces
Class ISeriesSortSequenceTable

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesSortSequenceTable
All Implemented Interfaces:
IISeriesSortSequenceTable

public class ISeriesSortSequenceTable
extends Object
implements IISeriesSortSequenceTable

This Java Bean represents the information stored in a Sort Sequence Table on the iSeries.


Field Summary
static String Copyright
           
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesSortSequenceTable
copyright, WEIGHT_SHARED, WEIGHT_UNIQUE
 
Constructor Summary
ISeriesSortSequenceTable()
          Constructor for ISeriesSortSequenceTable.
 
Method Summary
 int getBytesAvailable()
           
 int getBytesReturned()
           
 int getJobCCSID()
          CCSID of the job
 String getJobCountryID()
          Job country or region identifier
 String getJobLanguageID()
          Job language identifier
 String getJobSSTLibrary()
          Job sort sequence table library name
 String getJobSSTName()
          Job sort sequence table name
 byte[] getSST()
          Return the sort sequence table.
 int getTableCCSID()
          CCSID of the returned table
 String getTableLibrary()
          Table library name
 String getTableName()
          Table name
 char getWeighting()
          Weighting of returned sort sequence table
 boolean hasSubstitutionValues()
          Substiution values encountered
 void setBytesAvailable(int numBytes)
           
 void setBytesReturned(int numBytes)
           
 void setHasSubstitutionValues(boolean substitutionValues)
          Substiution values encountered
 void setJobCCSID(int ccsid)
          CCSID of the job
 void setJobCountryID(String countryID)
          Job country or region identifier
 void setJobLanguageID(String languageID)
          Job language identifier
 void setJobSSTLibrary(String name)
          Job sort sequence table library name
 void setJobSSTName(String name)
          Job sort sequence table name
 void setSST(byte[] sst)
          Sort sequence table.
 void setTableCCSID(int ccsid)
          CCSID of the returned table
 void setTableLibrary(String name)
          Table library name
 void setTableName(String name)
          Table name
 void setWeighting(char weight)
          Weighting of returned sort sequence table
 String toString()
          Create a string representation of this object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesSortSequenceTable

public ISeriesSortSequenceTable()
Constructor for ISeriesSortSequenceTable.

Method Detail

setBytesAvailable

public void setBytesAvailable(int numBytes)
Specified by:
setBytesAvailable in interface IISeriesSortSequenceTable

setBytesReturned

public void setBytesReturned(int numBytes)
Specified by:
setBytesReturned in interface IISeriesSortSequenceTable

setJobCCSID

public void setJobCCSID(int ccsid)
Description copied from interface: IISeriesSortSequenceTable
CCSID of the job

Specified by:
setJobCCSID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setJobCCSID(int)

setTableCCSID

public void setTableCCSID(int ccsid)
Description copied from interface: IISeriesSortSequenceTable
CCSID of the returned table

Specified by:
setTableCCSID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setTableCCSID(int)

setHasSubstitutionValues

public void setHasSubstitutionValues(boolean substitutionValues)
Description copied from interface: IISeriesSortSequenceTable
Substiution values encountered

Specified by:
setHasSubstitutionValues in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setHasSubstitutionValues(boolean)

setWeighting

public void setWeighting(char weight)
Description copied from interface: IISeriesSortSequenceTable
Weighting of returned sort sequence table

Specified by:
setWeighting in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setWeighting(char)

setTableName

public void setTableName(String name)
Description copied from interface: IISeriesSortSequenceTable
Table name

Specified by:
setTableName in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setTableName(String)

setTableLibrary

public void setTableLibrary(String name)
Description copied from interface: IISeriesSortSequenceTable
Table library name

Specified by:
setTableLibrary in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setTableLibrary(String)

setJobSSTName

public void setJobSSTName(String name)
Description copied from interface: IISeriesSortSequenceTable
Job sort sequence table name

Specified by:
setJobSSTName in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setJobSSTName(String)

setJobSSTLibrary

public void setJobSSTLibrary(String name)
Description copied from interface: IISeriesSortSequenceTable
Job sort sequence table library name

Specified by:
setJobSSTLibrary in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setJobSSTLibrary(String)

setJobLanguageID

public void setJobLanguageID(String languageID)
Description copied from interface: IISeriesSortSequenceTable
Job language identifier

Specified by:
setJobLanguageID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setJobLanguageID(String)

setJobCountryID

public void setJobCountryID(String countryID)
Description copied from interface: IISeriesSortSequenceTable
Job country or region identifier

Specified by:
setJobCountryID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setJobCountryID(String)

setSST

public void setSST(byte[] sst)
Description copied from interface: IISeriesSortSequenceTable
Sort sequence table. This must be a string of length 256;

Specified by:
setSST in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.setSST(byte[])

getJobCCSID

public int getJobCCSID()
Description copied from interface: IISeriesSortSequenceTable
CCSID of the job

Specified by:
getJobCCSID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getJobCCSID()

getTableCCSID

public int getTableCCSID()
Description copied from interface: IISeriesSortSequenceTable
CCSID of the returned table

Specified by:
getTableCCSID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getTableCCSID()

hasSubstitutionValues

public boolean hasSubstitutionValues()
Description copied from interface: IISeriesSortSequenceTable
Substiution values encountered

Specified by:
hasSubstitutionValues in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.hasSubstitutionValues()

getWeighting

public char getWeighting()
Description copied from interface: IISeriesSortSequenceTable
Weighting of returned sort sequence table

Specified by:
getWeighting in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getWeighting()

getTableName

public String getTableName()
Description copied from interface: IISeriesSortSequenceTable
Table name

Specified by:
getTableName in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getTableName()

getTableLibrary

public String getTableLibrary()
Description copied from interface: IISeriesSortSequenceTable
Table library name

Specified by:
getTableLibrary in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getTableLibrary()

getJobSSTName

public String getJobSSTName()
Description copied from interface: IISeriesSortSequenceTable
Job sort sequence table name

Specified by:
getJobSSTName in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getJobSSTName()

getJobSSTLibrary

public String getJobSSTLibrary()
Description copied from interface: IISeriesSortSequenceTable
Job sort sequence table library name

Specified by:
getJobSSTLibrary in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getJobSSTLibrary()

getJobLanguageID

public String getJobLanguageID()
Description copied from interface: IISeriesSortSequenceTable
Job language identifier

Specified by:
getJobLanguageID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getJobLanguageID()

getJobCountryID

public String getJobCountryID()
Description copied from interface: IISeriesSortSequenceTable
Job country or region identifier

Specified by:
getJobCountryID in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getJobCountryID()

getSST

public byte[] getSST()
Description copied from interface: IISeriesSortSequenceTable
Return the sort sequence table.

Specified by:
getSST in interface IISeriesSortSequenceTable
See Also:
IISeriesSortSequenceTable.getSST()

getBytesAvailable

public int getBytesAvailable()
Specified by:
getBytesAvailable in interface IISeriesSortSequenceTable

getBytesReturned

public int getBytesReturned()
Specified by:
getBytesReturned in interface IISeriesSortSequenceTable

toString

public String toString()
Create a string representation of this object

Overrides:
toString in class Object

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.