Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKFixedViewDataOD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKFixedViewDataOD
All Implemented Interfaces:
DKConstant, DKConstantOD, dkExtension, DKMessageId, java.io.Serializable

public class DKFixedViewDataOD
extends java.lang.Object
implements dkExtension, DKConstantOD, DKMessageId, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKFixedViewDataOD(char rotation, char prmode, java.lang.String printoptions, float paperwidth, float paperlength, char recordformat, int recordlen, java.lang.String recorddelimiter, char carriagecontrol, boolean trcpresent, int codepage, int pagebreaklinecount, int afptolinecharsperinch, int afptolinelinesperinch, int defpagestoprint, int numpageheaderrows, int numfieldheaderrows, int headervalidationrow, int headervalidationcol, java.lang.String headervalidationvalue, int numldfields)
          Constructs a new DKFixedViewOD object with input parameters.
 
Method Summary
 void addLDField(com.ibm.mm.sdk.internal.PLDFieldStructOD field)
           
 int getAfpToLineCharsPerInch()
          Gets the AfpToLineCharsPerInch
 int getAfpToLineLinesPerInch()
          Gets the AfpToLineLinesPerInch
 char getCarriageControl()
          Gets the CarriageControl
 int getCodepage()
          Gets the Codepage
 int getDefPagesToPrint()
          Gets the DefPagesToPrint
 int getHeaderValidationCol()
          Gets the HeaderValidationCol
 int getHeaderValidationRow()
          Gets the HeaderValidationRow
 java.lang.String getHeaderValidationValue()
          Gets the HeaderValidationValue
 DKSequentialCollection getLDFields()
           
 java.lang.String getName()
          Gets the name of this extension object
 int getNumFieldHeaderRows()
          Gets the NumFieldHeaderRows
 int getNumLDFields()
          Gets the number of defined line data fields
 int getNumPageHeaderRows()
          Gets the NumPageHeaderRows
 int getPageBreakLinecount()
          Gets the PageBreakLinecount
 float getPaperLength()
          Gets the PaperLength
 float getPaperWidth()
          Gets the PaperWidth
 java.lang.String getPrintOptions()
          Gets the PrintOptions
 char getPrMode()
          Gets the PrMode
 java.lang.String getRecordDelimiter()
          Gets the RecordDelimiter
 char getRecordFormat()
          Gets the RecordFormat
 int getRecordLen()
          Gets the RecordLen
 char getRotation()
          Gets the rotation
 boolean isTrcPresent()
          Tests whether or not Trc is present
 void setAfpToLineCharsPerInch(int i)
          Sets the AfpToLineCharsPerInch
 void setAfpToLineLinesPerInch(int i)
          Sets the AfpToLineLinesPerInch
 void setCarriageControl(char cc)
          Sets the CarriageControl
 void setCodepage(int cp)
          Sets the Codepage
 void setDefPagesToPrint(int numpages)
          Sets the DefPagesToPrint
 void setHeaderValidationCol(int i)
          Sets the HeaderValidationCol
 void setHeaderValidationRow(int i)
          Sets the HeaderValidationRow
 void setHeaderValidationValue(java.lang.String value)
          Sets the HeaderValidationValue
 void setName(java.lang.String extName)
          Sets the name of this extension object
 void setNumFieldHeaderRows(int i)
          Sets the NumFieldHeaderRows
 void setNumLDFields(int i)
          Sets the number of line data fields
 void setNumPageHeaderRows(int i)
          Sets the NumPageHeaderRows
 void setPageBreakLinecount(int i)
          Sets the PageBreakLinecount
 void setPaperLength(float length)
          Sets the PaperLength
 void setPaperWidth(float width)
          Sets the PaperWidth
 void setPrintOptions(java.lang.String options)
          Sets the PrintOptions
 void setPrMode(char prmode)
          Sets the PrMode
 void setRecordDelimiter(java.lang.String delim)
          Sets the RecordDelimiter
 void setRecordFormat(char recfmt)
          Sets the RecordFormat
 void setRecordLen(int reclen)
          Sets the RecordLen
 void setRotation(char rotation)
          Sets the rotation
 void setTrcPresent(boolean trc)
          Sets the TrcPresent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKFixedViewDataOD

public DKFixedViewDataOD(char rotation,
                         char prmode,
                         java.lang.String printoptions,
                         float paperwidth,
                         float paperlength,
                         char recordformat,
                         int recordlen,
                         java.lang.String recorddelimiter,
                         char carriagecontrol,
                         boolean trcpresent,
                         int codepage,
                         int pagebreaklinecount,
                         int afptolinecharsperinch,
                         int afptolinelinesperinch,
                         int defpagestoprint,
                         int numpageheaderrows,
                         int numfieldheaderrows,
                         int headervalidationrow,
                         int headervalidationcol,
                         java.lang.String headervalidationvalue,
                         int numldfields)
Constructs a new DKFixedViewOD object with input parameters.
Parameters:
rotation -  
prmode -  
printoptions -  
paperwidth -  
paperlength -  
recordformat -  
recorddelimiter -  
carriagecontrol -  
trcpresent -  
codepage -  
pagebreaklinecount -  
afptolinecharsperinch -  
afptolinelinesperinch -  
defpagestoprint -  
numpageheaderrows -  
numfieldheaderrows -  
headervalidationrow -  
headervalidatinocol -  
headervalidationvalue -  
numldfields -  
Method Detail

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object
Specified by:
getName in interface dkExtension
Returns:
name of this object

setName

public void setName(java.lang.String extName)
Sets the name of this extension object
Specified by:
setName in interface dkExtension
Parameters:
extName - name of this extension object

setRotation

public void setRotation(char rotation)
Sets the rotation
Parameters:
rotation -  

getRotation

public char getRotation()
Gets the rotation
Returns:
the rotation setting

setPrMode

public void setPrMode(char prmode)
Sets the PrMode
Parameters:
prmode -  

getPrMode

public char getPrMode()
Gets the PrMode
Returns:
the prmode setting

setPrintOptions

public void setPrintOptions(java.lang.String options)
Sets the PrintOptions
Parameters:
options -  

getPrintOptions

public java.lang.String getPrintOptions()
Gets the PrintOptions
Returns:
the printoptions setting

setPaperWidth

public void setPaperWidth(float width)
Sets the PaperWidth
Parameters:
width -  

getPaperWidth

public float getPaperWidth()
Gets the PaperWidth
Returns:
the paperwidth setting

setPaperLength

public void setPaperLength(float length)
Sets the PaperLength
Parameters:
length -  

getPaperLength

public float getPaperLength()
Gets the PaperLength
Returns:
the paperlength setting

setRecordFormat

public void setRecordFormat(char recfmt)
Sets the RecordFormat
Parameters:
recordformat -  

getRecordFormat

public char getRecordFormat()
Gets the RecordFormat
Returns:
the recordformat setting

setRecordLen

public void setRecordLen(int reclen)
Sets the RecordLen
Parameters:
recordlen -  

getRecordLen

public int getRecordLen()
Gets the RecordLen
Returns:
the recordlen setting

setRecordDelimiter

public void setRecordDelimiter(java.lang.String delim)
Sets the RecordDelimiter
Parameters:
recorddelimiter -  

getRecordDelimiter

public java.lang.String getRecordDelimiter()
Gets the RecordDelimiter
Returns:
the recorddelimiter setting

setCarriageControl

public void setCarriageControl(char cc)
Sets the CarriageControl
Parameters:
cc -  

getCarriageControl

public char getCarriageControl()
Gets the CarriageControl
Returns:
the carriagecontrol setting

setTrcPresent

public void setTrcPresent(boolean trc)
Sets the TrcPresent
Parameters:
trc -  

isTrcPresent

public boolean isTrcPresent()
Tests whether or not Trc is present
Returns:
true = trc is present, false otherwise

setCodepage

public void setCodepage(int cp)
Sets the Codepage
Parameters:
cp -  

getCodepage

public int getCodepage()
Gets the Codepage
Returns:
the codepage setting

setPageBreakLinecount

public void setPageBreakLinecount(int i)
Sets the PageBreakLinecount
Parameters:
i -  

getPageBreakLinecount

public int getPageBreakLinecount()
Gets the PageBreakLinecount
Returns:
the pagebreaklinecount setting

setAfpToLineCharsPerInch

public void setAfpToLineCharsPerInch(int i)
Sets the AfpToLineCharsPerInch
Parameters:
i -  

getAfpToLineCharsPerInch

public int getAfpToLineCharsPerInch()
Gets the AfpToLineCharsPerInch
Returns:
the afptolinecharsperinch setting

setAfpToLineLinesPerInch

public void setAfpToLineLinesPerInch(int i)
Sets the AfpToLineLinesPerInch
Parameters:
i -  

getAfpToLineLinesPerInch

public int getAfpToLineLinesPerInch()
Gets the AfpToLineLinesPerInch
Returns:
the afptolinelinesperinch setting

setDefPagesToPrint

public void setDefPagesToPrint(int numpages)
Sets the DefPagesToPrint
Parameters:
numpages -  

getDefPagesToPrint

public int getDefPagesToPrint()
Gets the DefPagesToPrint
Returns:
the default number of pages to print

setNumPageHeaderRows

public void setNumPageHeaderRows(int i)
Sets the NumPageHeaderRows
Parameters:
i -  

getNumPageHeaderRows

public int getNumPageHeaderRows()
Gets the NumPageHeaderRows
Returns:
the number of header rows

setNumFieldHeaderRows

public void setNumFieldHeaderRows(int i)
Sets the NumFieldHeaderRows
Parameters:
i -  

getNumFieldHeaderRows

public int getNumFieldHeaderRows()
Gets the NumFieldHeaderRows
Returns:
the number of field header rows

setHeaderValidationRow

public void setHeaderValidationRow(int i)
Sets the HeaderValidationRow
Parameters:
i -  

getHeaderValidationRow

public int getHeaderValidationRow()
Gets the HeaderValidationRow
Returns:
the row used for header validation

setHeaderValidationCol

public void setHeaderValidationCol(int i)
Sets the HeaderValidationCol
Parameters:
i -  

getHeaderValidationCol

public int getHeaderValidationCol()
Gets the HeaderValidationCol
Returns:
the column used for header validation

setHeaderValidationValue

public void setHeaderValidationValue(java.lang.String value)
Sets the HeaderValidationValue
Parameters:
value -  

getHeaderValidationValue

public java.lang.String getHeaderValidationValue()
Gets the HeaderValidationValue
Returns:
the value to be used for header validation

setNumLDFields

public void setNumLDFields(int i)
Sets the number of line data fields
Parameters:
i -  

getNumLDFields

public int getNumLDFields()
Gets the number of defined line data fields

addLDField

public void addLDField(com.ibm.mm.sdk.internal.PLDFieldStructOD field)
                throws java.lang.Exception

getLDFields

public DKSequentialCollection getLDFields()

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.