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

All Known Implementing Classes:

ISeriesEditDescription

public interface IISeriesEditDescription

This interface 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

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.

Field Detail

Copyright

static final String Copyright

See Also:

Constant Field Values

Method Detail

setNumber

void setNumber(char number)

Sets the edit description number (ID). Allowed values are 5 - 9.

setIntegerMask

void setIntegerMask(String integerMask)

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.

setDecimalPointCharacter

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. If the field has no decimal places, this character is not used and is not considered in the width of the edited results.

setFractionMask

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).

setFillCharacter

void setFillCharacter(char fillCharacter)

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).

setEditZeroValues

void setEditZeroValues(boolean editZeroValues)

Sets the edit zero values flag. The editing action for zero values.

setNegativeStatusCharacters

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. 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).

setPositiveStatusCharacters

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. 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).

setLeftConstantCharacters

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.

setRightConstantCharacters

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.

setDescription

void setDescription(String description)

Sets the description Text that briefly describes the edit description.

setFloatingString

void setFloatingString(String floatingString)

Sets the floating string

getNumber

char getNumber()

Get the edit description number (ID).

getIntegerMask

String getIntegerMask()

Get the integer mask:

See Also:

setIntegerMask(java.lang.String)

getDecimalPointCharacter

char getDecimalPointCharacter()

Get the decimal point character

See Also:

setDecimalPointCharacter(char)

getFractionMask

String getFractionMask()

Get the fraction mask

See Also:

setFractionMask(java.lang.String)

getFillCharacter

char getFillCharacter()

Get the fill character

See Also:

setFillCharacter(char)

isEditZeroValues

boolean isEditZeroValues()

Get the edit zero values flag.

See Also:

setEditZeroValues(boolean)

getNegativeStatusCharacters

String getNegativeStatusCharacters()

Get the negative status characters

See Also:

setNegativeStatusCharacters(java.lang.String)

getPositiveStatusCharacters

String getPositiveStatusCharacters()

Get the positive status charcters

See Also:

setPositiveStatusCharacters(java.lang.String)

getLeftConstantCharacters

String getLeftConstantCharacters()

Get the left constant characters

See Also:

setLeftConstantCharacters(java.lang.String)

getRightConstantCharacters

String getRightConstantCharacters()

Get the right constant characters

See Also:

setRightConstantCharacters(java.lang.String)

getDescription

String getDescription()

Get the description

See Also:

setDescription(java.lang.String)

getFloatingString

String getFloatingString()

Get the floating string