com.ibm.etools.cobol.application.model.cobol
Interface FileDescriptionEntry

All Superinterfaces:
ASTNode, org.eclipse.emf.ecore.EObject, NamedElement, org.eclipse.emf.common.notify.Notifier

public interface FileDescriptionEntry
extends NamedElement

A representation of a file description entry. This node represents both FD and SD entries.

The following features are supported:

See Also:
COBOLPackage.getFileDescriptionEntry()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 BlockContainsClause getBlockContainsClause()
          Returns the value of the 'Block Contains Clause' containment reference.
 Alphabet getCodeSet()
          Returns the value of the 'Code Set' reference.
 DataRecordClause getDataRecordClause()
          Returns the value of the 'Data Record Clause' containment reference.
 FileControlEntry getFileControlEntry()
          Returns the value of the 'File Control Entry' reference.
 java.util.List getFileRecordDescriptions()
          Returns the value of the 'File Record Descriptions' containment reference list.
 LabelRecordsClause getLabelRecordsClause()
          Returns the value of the 'Label Records Clause' containment reference.
 SimpleRefOrLiteral getLinage()
          Deprecated. Use getLinageClause() instead.
 LinageClause getLinageClause()
          Returns the value of the 'Linage Clause' containment reference.
 RecordClause getRecordClause()
          Returns the value of the 'Record Clause' containment reference.
 RecordingModeClause getRecordingModeClause()
          Returns the value of the 'Recording Mode Clause' containment reference.
 ValueOfClause getValueOfClause()
          Returns the value of the 'Value Of Clause' containment reference.
 boolean isExternal()
          Returns the value of the 'External' attribute.
 boolean isGlobal()
          Returns the value of the 'Global' attribute.
 boolean isSort()
          Returns the value of the 'Sort' attribute.
 void setBlockContainsClause(BlockContainsClause value)
          Sets the value of the 'Block Contains Clause' containment reference.
 void setCodeSet(Alphabet value)
          Sets the value of the 'Code Set' reference.
 void setDataRecordClause(DataRecordClause value)
          Sets the value of the 'Data Record Clause' containment reference.
 void setExternal(boolean value)
          Sets the value of the 'External' attribute.
 void setFileControlEntry(FileControlEntry value)
          Sets the value of the 'File Control Entry' reference.
 void setGlobal(boolean value)
          Sets the value of the 'Global' attribute.
 void setLabelRecordsClause(LabelRecordsClause value)
          Sets the value of the 'Label Records Clause' containment reference.
 void setLinage(SimpleRefOrLiteral value)
          Sets the value of the 'Linage' containment reference.
 void setLinageClause(LinageClause value)
          Sets the value of the 'Linage Clause' containment reference.
 void setRecordClause(RecordClause value)
          Sets the value of the 'Record Clause' containment reference.
 void setRecordingModeClause(RecordingModeClause value)
          Sets the value of the 'Recording Mode Clause' containment reference.
 void setSort(boolean value)
          Sets the value of the 'Sort' attribute.
 void setValueOfClause(ValueOfClause value)
          Sets the value of the 'Value Of Clause' containment reference.
 
Methods inherited from interface com.ibm.etools.cobol.application.model.cobol.NamedElement
getName, setName
 
Methods inherited from interface com.ibm.etools.cobol.application.model.cobol.ASTNode
getBeginColumn, getBeginFile, getBeginLine, getEndColumn, getEndFile, getEndLine, getParent, getTag, setBeginColumn, setBeginFile, setBeginLine, setEndColumn, setEndFile, setEndLine, setParent, setTag
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getFileControlEntry

FileControlEntry getFileControlEntry()
Returns the value of the 'File Control Entry' reference.

Returns:
the value of the 'File Control Entry' reference.
See Also:
setFileControlEntry(FileControlEntry), COBOLPackage.getFileDescriptionEntry_FileControlEntry()

setFileControlEntry

void setFileControlEntry(FileControlEntry value)
Sets the value of the 'File Control Entry' reference.

Parameters:
value - the new value of the 'File Control Entry' reference.
See Also:
getFileControlEntry()

getLinage

SimpleRefOrLiteral getLinage()
Deprecated. Use getLinageClause() instead.

Returns the value of the 'Linage' containment reference.

The value is the value specified in the LINAGE clause (either a literal or a simple reference).

Returns:
the value of the 'Linage' containment reference.
See Also:
setLinage(SimpleRefOrLiteral), COBOLPackage.getFileDescriptionEntry_Linage()

setLinage

void setLinage(SimpleRefOrLiteral value)
Sets the value of the 'Linage' containment reference.

Parameters:
value - the new value of the 'Linage' containment reference.
See Also:
getLinage()

getFileRecordDescriptions

java.util.List getFileRecordDescriptions()
Returns the value of the 'File Record Descriptions' containment reference list. The list contents are of type Level01Item.

The returned list contains the level 1 items that comprise the file record description.

Returns:
the value of the 'File Record Descriptions' containment reference list.
See Also:
COBOLPackage.getFileDescriptionEntry_FileRecordDescriptions()

isSort

boolean isSort()
Returns the value of the 'Sort' attribute.

Returns true if the entry is an SD entry; false if the entry is an FD entry.

Returns:
the value of the 'Sort' attribute.
See Also:
setSort(boolean), COBOLPackage.getFileDescriptionEntry_Sort()

setSort

void setSort(boolean value)
Sets the value of the 'Sort' attribute.

Parameters:
value - the new value of the 'Sort' attribute.
See Also:
isSort()

isExternal

boolean isExternal()
Returns the value of the 'External' attribute.

Returns true if the EXTERNAL clause is present; false otherwise.

Returns:
the value of the 'External' attribute.
See Also:
setExternal(boolean), COBOLPackage.getFileDescriptionEntry_External()

setExternal

void setExternal(boolean value)
Sets the value of the 'External' attribute.

Parameters:
value - the new value of the 'External' attribute.
See Also:
isExternal()

isGlobal

boolean isGlobal()
Returns the value of the 'Global' attribute.

Returns true if the GLOBAL clause is present; false otherwise.

Returns:
the value of the 'Global' attribute.
See Also:
setGlobal(boolean), COBOLPackage.getFileDescriptionEntry_Global()

setGlobal

void setGlobal(boolean value)
Sets the value of the 'Global' attribute.

Parameters:
value - the new value of the 'Global' attribute.
See Also:
isGlobal()

getBlockContainsClause

BlockContainsClause getBlockContainsClause()
Returns the value of the 'Block Contains Clause' containment reference.

The value is a representation of the BLOCK CONTAINS clause. If the clause is not present, null is returned.

Returns:
the value of the 'Block Contains Clause' containment reference.
See Also:
setBlockContainsClause(BlockContainsClause), COBOLPackage.getFileDescriptionEntry_BlockContainsClause()

setBlockContainsClause

void setBlockContainsClause(BlockContainsClause value)
Sets the value of the 'Block Contains Clause' containment reference.

Parameters:
value - the new value of the 'Block Contains Clause' containment reference.
See Also:
getBlockContainsClause()

getRecordClause

RecordClause getRecordClause()
Returns the value of the 'Record Clause' containment reference.

The value is a representation of the RECORD clause. If the clause is not present, null is returned.

Returns:
the value of the 'Record Clause' containment reference.
See Also:
setRecordClause(RecordClause), COBOLPackage.getFileDescriptionEntry_RecordClause()

setRecordClause

void setRecordClause(RecordClause value)
Sets the value of the 'Record Clause' containment reference.

Parameters:
value - the new value of the 'Record Clause' containment reference.
See Also:
getRecordClause()

getLabelRecordsClause

LabelRecordsClause getLabelRecordsClause()
Returns the value of the 'Label Records Clause' containment reference.

The value is a representation of the LABEL RECORDS clause. If the clause is not present, the value is null.

Returns:
the value of the 'Label Records Clause' containment reference.
See Also:
setLabelRecordsClause(LabelRecordsClause), COBOLPackage.getFileDescriptionEntry_LabelRecordsClause()

setLabelRecordsClause

void setLabelRecordsClause(LabelRecordsClause value)
Sets the value of the 'Label Records Clause' containment reference.

Parameters:
value - the new value of the 'Label Records Clause' containment reference.
See Also:
getLabelRecordsClause()

getValueOfClause

ValueOfClause getValueOfClause()
Returns the value of the 'Value Of Clause' containment reference.

The value is a representation of the VALUE OF clause. If the clause is not present, the value is null.

Returns:
the value of the 'Value Of Clause' containment reference.
See Also:
setValueOfClause(ValueOfClause), COBOLPackage.getFileDescriptionEntry_ValueOfClause()

setValueOfClause

void setValueOfClause(ValueOfClause value)
Sets the value of the 'Value Of Clause' containment reference.

Parameters:
value - the new value of the 'Value Of Clause' containment reference.
See Also:
getValueOfClause()

getLinageClause

LinageClause getLinageClause()
Returns the value of the 'Linage Clause' containment reference.

The value is a representation of the LINAGE clause. If the LINAGE clause is not present, the value is null.

Returns:
the value of the 'Linage Clause' containment reference.
See Also:
setLinageClause(LinageClause), COBOLPackage.getFileDescriptionEntry_LinageClause()

setLinageClause

void setLinageClause(LinageClause value)
Sets the value of the 'Linage Clause' containment reference.

Parameters:
value - the new value of the 'Linage Clause' containment reference.
See Also:
getLinageClause()

getRecordingModeClause

RecordingModeClause getRecordingModeClause()
Returns the value of the 'Recording Mode Clause' containment reference.

The value is a representation of the RECORDING MODE clause. If the clause is not present, the value is null.

Returns:
the value of the 'Recording Mode Clause' containment reference.
See Also:
setRecordingModeClause(RecordingModeClause), COBOLPackage.getFileDescriptionEntry_RecordingModeClause()

setRecordingModeClause

void setRecordingModeClause(RecordingModeClause value)
Sets the value of the 'Recording Mode Clause' containment reference.

Parameters:
value - the new value of the 'Recording Mode Clause' containment reference.
See Also:
getRecordingModeClause()

getCodeSet

Alphabet getCodeSet()
Returns the value of the 'Code Set' reference.

The value is the alphabet specified in the CODE-SET clause. If the clause is not present, the value is null.

Returns:
the value of the 'Code Set' reference.
See Also:
setCodeSet(Alphabet), COBOLPackage.getFileDescriptionEntry_CodeSet()

setCodeSet

void setCodeSet(Alphabet value)
Sets the value of the 'Code Set' reference.

Parameters:
value - the new value of the 'Code Set' reference.
See Also:
getCodeSet()

getDataRecordClause

DataRecordClause getDataRecordClause()
Returns the value of the 'Data Record Clause' containment reference.

The value is a representation of the DATA RECORD clause; if there is no DATA RECORD clause, the value is null.

Returns:
the value of the 'Data Record Clause' containment reference.
See Also:
setDataRecordClause(DataRecordClause), COBOLPackage.getFileDescriptionEntry_DataRecordClause()

setDataRecordClause

void setDataRecordClause(DataRecordClause value)
Sets the value of the 'Data Record Clause' containment reference.

Parameters:
value - the new value of the 'Data Record Clause' containment reference.
See Also:
getDataRecordClause()