Rational Developer for Power Systems Software
V7.6

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

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

public class ISeriesEditDescription
extends Object
implements IISeriesEditDescription

This class represents an edit description (user defined edit code) on the iSeries. It holds the information contained in an object of type *EDTD


Field Summary
static String Copyright
           
 
Constructor Summary
ISeriesEditDescription()
          Constructor for ISeriesEditDescription.
 
Method Summary
 char getDecimalPointCharacter()
          Get the decimal point character
 String getDescription()
          Get the description
 char getFillCharacter()
          Get the fill character
 String getFloatingString()
          Get the floating string
 String getFractionMask()
          Get the fraction mask
 String getIntegerMask()
          Get the integer mask:
 String getLeftConstantCharacters()
          Get the left constant characters
 String getNegativeStatusCharacters()
          Get the negative status characters
 char getNumber()
          Get the edit description number (ID).
 String getPositiveStatusCharacters()
          Get the positive status charcters
 String getRightConstantCharacters()
          Get the right constant characters
 boolean isEditZeroValues()
          Get the edit zero values flag.
 void setDecimalPointCharacter(char decimalPointCharacter)
          Sets the decimal point character For decimal fields, this is a single character used as a decimal point to separate the integer (INTMASK) and fraction (FRACMASK) portions of the edited result.
 void setDescription(String description)
          Sets the description Text that briefly describes the edit description.
 void setEditZeroValues(boolean editZeroValues)
          Sets the edit zero values flag.
 void setFillCharacter(char fillCharacter)
          Sets the fill character The character that is used in each position of a result that is zero suppressed.
 void setFloatingString(String floatingString)
          Sets the floating string
 void setFractionMask(String fractionMask)
          Sets the fraction mask A character string (mask) that describes the editing of the fraction portion of a decimal field (to the right of the decimal point).
 void setIntegerMask(String integerMask)
          Sets the integer mask: A character string (mask) that describes the editing of the integer portion of a decimal field.
 void setLeftConstantCharacters(String leftConstantCharacters)
          Sets the left constant characters The character string constant that always appears as the farthest left portion of the edited result.
 void setNegativeStatusCharacters(String negativeStatusCharacters)
          Sets the negative status characters The character string that immediately follows the body of the edited result if the field is negative.
 void setNumber(char number)
          Sets the edit description number (ID).
 void setPositiveStatusCharacters(String positiveStatusCharacters)
          Sets the positive status charcters The character string that immediately follows the body of the edited result if the field is positive or zero.
 void setRightConstantCharacters(String rightConstantCharacters)
          Sets the right constant characters The character string constant that always appears as the farthest right portion of the edited result.
 String toString()
          Create String representation of this edit description
 
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

ISeriesEditDescription

public ISeriesEditDescription()
Constructor for ISeriesEditDescription.

Method Detail

setNumber

public void setNumber(char number)
Description copied from interface: IISeriesEditDescription
Sets the edit description number (ID). Allowed values are 5 - 9.

Specified by:
setNumber in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setNumber(char)

setIntegerMask

public void setIntegerMask(String integerMask)
Description copied from interface: IISeriesEditDescription
Sets the integer mask: A character string (mask) that describes the editing of the integer portion of a decimal field. Characters other than a blank, a zero, or an ampersand (&) are handled as constants in the editing process.

Specified by:
setIntegerMask in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setIntegerMask(String)

setDecimalPointCharacter

public void setDecimalPointCharacter(char decimalPointCharacter)
Description copied from interface: IISeriesEditDescription
Sets the decimal point character For decimal fields, this is a single character used as a decimal point to separate the integer (INTMASK) and fraction (FRACMASK) portions of the edited result. If the field has no decimal places, this character is not used and is not considered in the width of the edited results.

Specified by:
setDecimalPointCharacter in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setDecimalPointCharacter(char)

setFractionMask

public void setFractionMask(String fractionMask)
Description copied from interface: IISeriesEditDescription
Sets the fraction mask A character string (mask) that describes the editing of the fraction portion of a decimal field (to the right of the decimal point).

Specified by:
setFractionMask in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setFractionMask(String)

setFillCharacter

public void setFillCharacter(char fillCharacter)
Description copied from interface: IISeriesEditDescription
Sets the fill character The character that is used in each position of a result that is zero suppressed. The specified character replaces all leading zeros that are to the left of the first significant digit in the integer mask (or a forced zero).

Specified by:
setFillCharacter in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setFillCharacter(char)

setEditZeroValues

public void setEditZeroValues(boolean editZeroValues)
Description copied from interface: IISeriesEditDescription
Sets the edit zero values flag. The editing action for zero values.

Specified by:
setEditZeroValues in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setEditZeroValues(boolean)

setNegativeStatusCharacters

public void setNegativeStatusCharacters(String negativeStatusCharacters)
Description copied from interface: IISeriesEditDescription
Sets the negative status characters The character string that immediately follows the body of the edited result if the field is negative. If the field is positive, blanks are substituted for the length of the string, unless a value is also specified for the Positive status characters prompt (POSSTS parameter).

Specified by:
setNegativeStatusCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setNegativeStatusCharacters(String)

setPositiveStatusCharacters

public void setPositiveStatusCharacters(String positiveStatusCharacters)
Description copied from interface: IISeriesEditDescription
Sets the positive status charcters The character string that immediately follows the body of the edited result if the field is positive or zero. If the field is negative, blanks are substituted for the length of the string unless a value is also specified for the Negative status characters prompt (NEGSTS parameter).

Specified by:
setPositiveStatusCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setPositiveStatusCharacters(String)

setLeftConstantCharacters

public void setLeftConstantCharacters(String leftConstantCharacters)
Description copied from interface: IISeriesEditDescription
Sets the left constant characters The character string constant that always appears as the farthest left portion of the edited result.

Specified by:
setLeftConstantCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setLeftConstantCharacters(String)

setRightConstantCharacters

public void setRightConstantCharacters(String rightConstantCharacters)
Description copied from interface: IISeriesEditDescription
Sets the right constant characters The character string constant that always appears as the farthest right portion of the edited result.

Specified by:
setRightConstantCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setRightConstantCharacters(String)

setDescription

public void setDescription(String description)
Description copied from interface: IISeriesEditDescription
Sets the description Text that briefly describes the edit description.

Specified by:
setDescription in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setDescription(String)

getNumber

public char getNumber()
Description copied from interface: IISeriesEditDescription
Get the edit description number (ID).

Specified by:
getNumber in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setNumber(char)

getIntegerMask

public String getIntegerMask()
Description copied from interface: IISeriesEditDescription
Get the integer mask:

Specified by:
getIntegerMask in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getIntegerMask()

getDecimalPointCharacter

public char getDecimalPointCharacter()
Description copied from interface: IISeriesEditDescription
Get the decimal point character

Specified by:
getDecimalPointCharacter in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getDecimalPointCharacter()

getFractionMask

public String getFractionMask()
Description copied from interface: IISeriesEditDescription
Get the fraction mask

Specified by:
getFractionMask in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getFractionMask()

getFillCharacter

public char getFillCharacter()
Description copied from interface: IISeriesEditDescription
Get the fill character

Specified by:
getFillCharacter in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getFillCharacter()

isEditZeroValues

public boolean isEditZeroValues()
Description copied from interface: IISeriesEditDescription
Get the edit zero values flag.

Specified by:
isEditZeroValues in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.isEditZeroValues()

getNegativeStatusCharacters

public String getNegativeStatusCharacters()
Description copied from interface: IISeriesEditDescription
Get the negative status characters

Specified by:
getNegativeStatusCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getNegativeStatusCharacters()

getPositiveStatusCharacters

public String getPositiveStatusCharacters()
Description copied from interface: IISeriesEditDescription
Get the positive status charcters

Specified by:
getPositiveStatusCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getPositiveStatusCharacters()

getLeftConstantCharacters

public String getLeftConstantCharacters()
Description copied from interface: IISeriesEditDescription
Get the left constant characters

Specified by:
getLeftConstantCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getLeftConstantCharacters()

getRightConstantCharacters

public String getRightConstantCharacters()
Description copied from interface: IISeriesEditDescription
Get the right constant characters

Specified by:
getRightConstantCharacters in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getRightConstantCharacters()

getDescription

public String getDescription()
Description copied from interface: IISeriesEditDescription
Get the description

Specified by:
getDescription in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getDescription()

getFloatingString

public String getFloatingString()
Description copied from interface: IISeriesEditDescription
Get the floating string

Specified by:
getFloatingString in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.getFloatingString()

setFloatingString

public void setFloatingString(String floatingString)
Description copied from interface: IISeriesEditDescription
Sets the floating string

Specified by:
setFloatingString in interface IISeriesEditDescription
See Also:
IISeriesEditDescription.setFloatingString(String)

toString

public String toString()
Create String representation of this edit description

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.