Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesConvertEditCode

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

public class ISeriesConvertEditCode
extends ISeriesAbstractHostAPIProcessor

A Java wrapper for the OS/400 Convert Edit Code (QECCVTEC) system API which translates an edit code specification into an edit mask, which is a byte string used to format a numeric value into a readable character string.


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
ISeriesConvertEditCode()
          Constructor to use when you do not already have an AS400 object.
ISeriesConvertEditCode(AS400 system)
          Constructor for ISeriesConvertEditCode.
 
Method Summary
 IISeriesEditMask createEditMask(char editCode, char fillChar, int precision, int decimals)
          Create an edit mask for the specified edit code.
 
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

ISeriesConvertEditCode

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


ISeriesConvertEditCode

public ISeriesConvertEditCode(AS400 system)
Constructor for ISeriesConvertEditCode.

Method Detail

createEditMask

public IISeriesEditMask createEditMask(char editCode,
                                       char fillChar,
                                       int precision,
                                       int decimals)
                                throws Exception
Create an edit mask for the specified edit code.

Parameters:
editCode - The edit code that is to be translated into an edit mask. The valid values are: A-D, J-Q, W, Y-Z and 1-9
fillChar - Fill or floating currency indication. Indicates how the output should be padded on the left. This parameter should be specified as follows:
  • " " Blank fill: All suppressed zeros are replaced with blanks.
  • "*" Asterisk fill: All suppressed zeros are replaced with asterisks.
  • Character Blank fill: The specified character is used as a floating currency symbol and placed to the left of the first nonsuppressed digit. Characters are X'41' to X'FE'.
precision - Source variable precision. The precision of the numeric variable that is edited with the edit mask. Precision is the displayed length of a field, not including the decimal point. The valid ranges depend on the value specified for the edit code.
decimals - Source variable decimal positions. The number of digits that the source variable precision parameter has placed after the decimal point in the edited output. The value must be less than or equal to source variable precision, but greater than 0.
Returns:
An IISeriesEditMask instance containing the edit mask information.
Throws:
ISeriesAPIErrorCodeException - if there was an error while running the OS/400 system api
IBM - Toolbox for Java exceptions if there was a problem calling the OS/400 system api
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.