Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesRetrieveSortSeqTable

java.lang.Object
  extended by com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
      extended by com.ibm.etools.iseries.comm.ISeriesRetrieveSortSeqTable
All Implemented Interfaces:
IISeriesAPIProcessor

public class ISeriesRetrieveSortSeqTable
extends ISeriesAbstractHostAPIProcessor

A class for retrieving a sort sequence table from the iSeries. This class uses the QLGRTVSS OS/400 system api. Currently only the RSST0100 format is supported.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
ISeriesAbstractHostAPIProcessor.HostAPIErrorCodeStructure
 
Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
cancel, cancellableSubTasks, cancelQuerier, CREATE_FALSE, CREATE_TRUE, dbcsConvert, DEFAULT_OBJECT_FACTORY_BASIC, DEFAULT_OBJECT_FACTORY_BRIEF, DEFAULT_OBJECT_FACTORY_EXHAUSTIVE, DEFAULT_OBJECT_FACTORY_NAMEONLY, errorcodeObj, hostAPILibraries, INFOLEVEL_BASIC, INFOLEVEL_BRIEF, INFOLEVEL_EXHAUSTIVE, INFOLEVEL_NAME, INFOLEVEL_NAMEARRAY, INITIAL_SPACESIZE, LOG_DIR, LOG_FILENAME, logFile, logFileStream, logLineCounter, logStandardOut, NEED_USERSPACE_NO, NEED_USERSPACE_YES, objName, objType, QVDEOBJLinfo, returnObjectFactory, todos, tracePrefix, warnings
 
Constructor Summary
ISeriesRetrieveSortSeqTable()
          Constructor to use when you do not already have an AS400 object.
ISeriesRetrieveSortSeqTable(AS400 system)
          Constructor for ISeriesRetrieveSortSeqTable.
 
Method Summary
 IISeriesSortSequenceTable getSortSequenceTable(String tableName, String tableLibrary, String langID, int ccsid)
          Retrieve the sort sequence table from the iSeries
 
Methods inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
addCancellableSubTask, addWarning, cancel, clearWarnings, closeUserSpace, computeSize, createUserSpaceOnHost, determineInfoLevel, getClientCCSID, getDefaultObjectFactory, getErrorCodeStructure, getHostCCSID, getLibrary, getLogFileStream, getObjectFactory, getObjectName, getObjectType, getSystem, getUserSpace, getUserSpaceAPIName, getUserSpaceIFSName, getUserSpaceLibrary, getUserSpaceName, getWarnings, isCancelled, isTraceOn, logException, logHostMessages, logMessage, logMessage, logMessage, logTodo, openUserSpace, padString, parseBin8Date, parseChar13Date, parseChar7Date, parseChar8Date, readUserSpace, readUserSpace, registerCancelQuerier, removeCancellableSubTask, setClientCCSID, setHostCCSID, setLibrary, setLogFileDirectory, setObjectFactory, setObjectName, setObjectType, setSystem, setTracing, setUserSpaceLibrary, setUserSpaceName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

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

ISeriesRetrieveSortSeqTable

public ISeriesRetrieveSortSeqTable()
Constructor to use when you do not already have an AS400 object. A new AS400 object will be created when getSortSequenceTable is called, unless you subsequently call setSystem(AS400) first.


ISeriesRetrieveSortSeqTable

public ISeriesRetrieveSortSeqTable(AS400 system)
Constructor for ISeriesRetrieveSortSeqTable.

Method Detail

getSortSequenceTable

public IISeriesSortSequenceTable getSortSequenceTable(String tableName,
                                                      String tableLibrary,
                                                      String langID,
                                                      int ccsid)
                                               throws Exception
Retrieve the sort sequence table from the iSeries

Parameters:
tableName - The name of the sort sequence table
tableLibrary - The library where the table resides
langID - The language identifier of the sort sequence table to be used
ccsid - The CCSID in which the table is to be returned
Returns:
The sort sequence table information.
Throws:
ISeriesAPIErrorCodeException - If the OS/400 api call returns an error code
Toolbox - exceptions if any errors occur while calling the api via the Toolbox's ProgramCall class
Exception

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.