Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.interfaces
Interface IISeriesSortSequenceTable

All Known Implementing Classes:
ISeriesSortSequenceTable

public interface IISeriesSortSequenceTable

This interface encapsulates the information stored in a Sort Sequence Table on the iSeries.

See Also:
ISeriesRetrieveSortSeqTable

Field Summary
static String copyright
           
static char WEIGHT_SHARED
          A shared-weight sort sequence table.
static char WEIGHT_UNIQUE
          A unique-weight sort sequence table.
 
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
 

Field Detail

copyright

static final String copyright
See Also:
Constant Field Values

WEIGHT_SHARED

static final char WEIGHT_SHARED
A shared-weight sort sequence table.

See Also:
Constant Field Values

WEIGHT_UNIQUE

static final char WEIGHT_UNIQUE
A unique-weight sort sequence table.

See Also:
Constant Field Values
Method Detail

setJobCCSID

void setJobCCSID(int ccsid)
CCSID of the job


setTableCCSID

void setTableCCSID(int ccsid)
CCSID of the returned table


setHasSubstitutionValues

void setHasSubstitutionValues(boolean substitutionValues)
Substiution values encountered


setWeighting

void setWeighting(char weight)
Weighting of returned sort sequence table


setTableName

void setTableName(String name)
Table name


setTableLibrary

void setTableLibrary(String name)
Table library name


setJobSSTName

void setJobSSTName(String name)
Job sort sequence table name


setJobSSTLibrary

void setJobSSTLibrary(String name)
Job sort sequence table library name


setJobLanguageID

void setJobLanguageID(String languageID)
Job language identifier


setJobCountryID

void setJobCountryID(String countryID)
Job country or region identifier


setSST

void setSST(byte[] sst)
Sort sequence table. This must be a string of length 256;


getJobCCSID

int getJobCCSID()
CCSID of the job


getTableCCSID

int getTableCCSID()
CCSID of the returned table


hasSubstitutionValues

boolean hasSubstitutionValues()
Substiution values encountered


getWeighting

char getWeighting()
Weighting of returned sort sequence table

See Also:
WEIGHT_SHARED, WEIGHT_UNIQUE

getTableName

String getTableName()
Table name


getTableLibrary

String getTableLibrary()
Table library name


getJobSSTName

String getJobSSTName()
Job sort sequence table name


getJobSSTLibrary

String getJobSSTLibrary()
Job sort sequence table library name


getJobLanguageID

String getJobLanguageID()
Job language identifier


getJobCountryID

String getJobCountryID()
Job country or region identifier


setBytesAvailable

void setBytesAvailable(int numBytes)

setBytesReturned

void setBytesReturned(int numBytes)

getBytesAvailable

int getBytesAvailable()

getBytesReturned

int getBytesReturned()

getSST

byte[] getSST()
Return the sort sequence table.


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.