Rational Developer for Power Systems Software
V7.6

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

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

public class ISeriesEditDescriptionsInfo
extends Object
implements IISeriesEditDescriptionsInfo

This Java Bean represents the information required for processing edit codes. This includes system information like the currency symbol and decimal / date / time spearators as well as the edit descriptions for the system.


Field Summary
static String Copyright
           
 
Constructor Summary
ISeriesEditDescriptionsInfo()
          Constructor for ISeriesEditCodeInformation.
 
Method Summary
 char getCurrencySymbol()
          Get the currency symbol retrieved from the QCURSYS system value.
 String getDateFormat()
          Get the date format retrieved from the iSeries job.
 char getDateSeparator()
          Get the date separator char.
 char getDecimalSeparator()
          Get the decimal separator char.
 List getEditDescriptions()
          Get the edit descriptions.
 String getJobDescription()
          Get the job description used in retrieving the values.
 String getJobDescriptionLibrary()
          Get the library where the job description, used in retrieving the values, is stored.
 char getTimeSeparator()
          Get the time separator char.
 String getUserID()
          Get the user ID used to retrieve the values.
 void setCurrencySymbol(char currencySymbol)
          Sets the currency symbol retrieved from the QCURSYS system value.
 void setDateFormat(String systemDateFormat)
          Sets the date format retrieved from the iSeries job.
 void setDateSeparator(char dateSeparator)
          Sets the date separator char.
 void setDecimalSeparator(char decimalSeparator)
          Sets the decimal separator char.
 void setEditDescriptions(List editDescriptions)
          Set the edit descriptions.
 void setJobDescription(String jobDescription)
          Sets the job description used in retrieving the values.
 void setJobDescriptionLibrary(String library)
          Sets the library where the job description, used in retrieving the values, is stored.
 void setTimeSeparator(char timeSeparator)
          Sets the time separator char.
 void setUserID(String userID)
          Sets the user ID used to retrieve the values.
 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

ISeriesEditDescriptionsInfo

public ISeriesEditDescriptionsInfo()
Constructor for ISeriesEditCodeInformation.

Method Detail

setCurrencySymbol

public void setCurrencySymbol(char currencySymbol)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the currency symbol retrieved from the QCURSYS system value.

Specified by:
setCurrencySymbol in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setCurrencySymbol(char)

setDateFormat

public void setDateFormat(String systemDateFormat)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the date format retrieved from the iSeries job.

Specified by:
setDateFormat in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setDateFormat(String)

setDecimalSeparator

public void setDecimalSeparator(char decimalSeparator)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the decimal separator char.

Specified by:
setDecimalSeparator in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setDecimalSeparator(char)

setDateSeparator

public void setDateSeparator(char dateSeparator)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the date separator char.

Specified by:
setDateSeparator in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setDateSeparator(char)

setTimeSeparator

public void setTimeSeparator(char timeSeparator)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the time separator char.

Specified by:
setTimeSeparator in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setTimeSeparator(char)

setUserID

public void setUserID(String userID)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the user ID used to retrieve the values.

Specified by:
setUserID in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setUserID(String)

setJobDescription

public void setJobDescription(String jobDescription)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the job description used in retrieving the values.

Specified by:
setJobDescription in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setJobDescription(String)

setJobDescriptionLibrary

public void setJobDescriptionLibrary(String library)
Description copied from interface: IISeriesEditDescriptionsInfo
Sets the library where the job description, used in retrieving the values, is stored.

Specified by:
setJobDescriptionLibrary in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setJobDescriptionLibrary(String)

setEditDescriptions

public void setEditDescriptions(List editDescriptions)
Description copied from interface: IISeriesEditDescriptionsInfo
Set the edit descriptions. The collection must contain only instances of IISeriesEditDescription.

Specified by:
setEditDescriptions in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.setEditDescriptions(List)

getCurrencySymbol

public char getCurrencySymbol()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the currency symbol retrieved from the QCURSYS system value.

Specified by:
getCurrencySymbol in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getCurrencySymbol()

getDateFormat

public String getDateFormat()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the date format retrieved from the iSeries job.

Specified by:
getDateFormat in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getDateFormat()

getDecimalSeparator

public char getDecimalSeparator()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the decimal separator char.

Specified by:
getDecimalSeparator in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getDecimalSeparator()

getDateSeparator

public char getDateSeparator()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the date separator char.

Specified by:
getDateSeparator in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getDateSeparator()

getTimeSeparator

public char getTimeSeparator()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the time separator char.

Specified by:
getTimeSeparator in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getTimeSeparator()

getUserID

public String getUserID()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the user ID used to retrieve the values.

Specified by:
getUserID in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getUserID()

getJobDescription

public String getJobDescription()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the job description used in retrieving the values.

Specified by:
getJobDescription in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getJobDescription()

getJobDescriptionLibrary

public String getJobDescriptionLibrary()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the library where the job description, used in retrieving the values, is stored.

Specified by:
getJobDescriptionLibrary in interface IISeriesEditDescriptionsInfo
See Also:
IISeriesEditDescriptionsInfo.getJobDescriptionLibrary()

getEditDescriptions

public List getEditDescriptions()
Description copied from interface: IISeriesEditDescriptionsInfo
Get the edit descriptions.

Specified by:
getEditDescriptions in interface IISeriesEditDescriptionsInfo
Returns:
A List of IISeriesEditDescription objects.
See Also:
IISeriesEditDescriptionsInfo.getEditDescriptions()

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.