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

All Superinterfaces:
ASTNode, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
IndexedFileControlEntry, LineSequentialFileControlEntry, RelativeFileControlEntry, SequentialFileControlEntry

public interface FileControlEntry
extends ASTNode

A representation of a file control entry in the INPUT-OUTPUT section of the ENVIRONMENT division.

The following features are supported:

See Also:
COBOLPackage.getFileControlEntry()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List getAssignmentNames()
          Returns the value of the 'Assignment Names' containment reference list.
 Literal getAssignTo()
          Deprecated. Use getAssignmentNames() instead.
 AbstractDataItem getAssignUsing()
          Deprecated. Use getAssignmentNames() instead.
 FileAccessModeClause getFileAccessModeClause()
          Returns the value of the 'File Access Mode Clause' containment reference.
 AbstractDataItem getPassword()
          Returns the value of the 'Password' reference.
 AbstractDataItem getPlatformSpecificStatus()
          Returns the value of the 'Platform Specific Status' reference.
 ReservePhrase getReservePhrase()
          Returns the value of the 'Reserve Phrase' containment reference.
 FileDescriptionEntry getSelect()
          Returns the value of the 'Select' reference.
 AbstractDataItem getStatus()
          Returns the value of the 'Status' reference.
 boolean isAutomaticLockMode()
          Deprecated. This was a superfluous method.

 boolean isIsOptional()
          Returns the value of the 'Is Optional' attribute.
 boolean isWithLockOnRecord()
          Deprecated. This was a superfluous method.

 void setAssignTo(Literal value)
          Sets the value of the 'Assign To' containment reference.
 void setAssignUsing(AbstractDataItem value)
          Sets the value of the 'Assign Using' reference.
 void setAutomaticLockMode(boolean value)
          Deprecated. This was a superfluous method.
 void setFileAccessModeClause(FileAccessModeClause value)
          Sets the value of the 'File Access Mode Clause' containment reference.
 void setIsOptional(boolean value)
          Sets the value of the 'Is Optional' attribute.
 void setPassword(AbstractDataItem value)
          Sets the value of the 'Password' reference.
 void setPlatformSpecificStatus(AbstractDataItem value)
          Sets the value of the 'Platform Specific Status' reference.
 void setReservePhrase(ReservePhrase value)
          Sets the value of the 'Reserve Phrase' containment reference.
 void setSelect(FileDescriptionEntry value)
          Sets the value of the 'Select' reference.
 void setStatus(AbstractDataItem value)
          Sets the value of the 'Status' reference.
 void setWithLockOnRecord(boolean value)
          Deprecated. This was a superfluous method.
 
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

getSelect

FileDescriptionEntry getSelect()
Returns the value of the 'Select' reference.

The value is the file description entry specified in the SELECT clause.

Returns:
the value of the 'Select' reference.
See Also:
setSelect(FileDescriptionEntry), COBOLPackage.getFileControlEntry_Select()

setSelect

void setSelect(FileDescriptionEntry value)
Sets the value of the 'Select' reference.

Parameters:
value - the new value of the 'Select' reference.
See Also:
getSelect()

isIsOptional

boolean isIsOptional()
Returns the value of the 'Is Optional' attribute.

The value is true if the OPTIONAL keyword is present; false otherwise.

Returns:
the value of the 'Is Optional' attribute.
See Also:
setIsOptional(boolean), COBOLPackage.getFileControlEntry_IsOptional()

setIsOptional

void setIsOptional(boolean value)
Sets the value of the 'Is Optional' attribute.

Parameters:
value - the new value of the 'Is Optional' attribute.
See Also:
isIsOptional()

getAssignTo

Literal getAssignTo()
Deprecated. Use getAssignmentNames() instead.

Returns the value of the 'Assign To' containment reference.

The value is the assignment name specified in the ASSIGN TO clause.

Returns:
the value of the 'Assign To' containment reference.
See Also:
setAssignTo(Literal), COBOLPackage.getFileControlEntry_AssignTo()

setAssignTo

void setAssignTo(Literal value)
Sets the value of the 'Assign To' containment reference.

Parameters:
value - the new value of the 'Assign To' containment reference.
See Also:
getAssignTo()

getAssignUsing

AbstractDataItem getAssignUsing()
Deprecated. Use getAssignmentNames() instead.

Returns the value of the 'Assign Using' reference.

The value is the data item specified in the ASSIGN USING clause.

Returns:
the value of the 'Assign Using' reference.
See Also:
setAssignUsing(AbstractDataItem), COBOLPackage.getFileControlEntry_AssignUsing()

setAssignUsing

void setAssignUsing(AbstractDataItem value)
Sets the value of the 'Assign Using' reference.

Parameters:
value - the new value of the 'Assign Using' reference.
See Also:
getAssignUsing()

getReservePhrase

ReservePhrase getReservePhrase()
Returns the value of the 'Reserve Phrase' containment reference.

The value is the RESERVE clause.

Returns:
the value of the 'Reserve Phrase' containment reference.
See Also:
setReservePhrase(ReservePhrase), COBOLPackage.getFileControlEntry_ReservePhrase()

setReservePhrase

void setReservePhrase(ReservePhrase value)
Sets the value of the 'Reserve Phrase' containment reference.

Parameters:
value - the new value of the 'Reserve Phrase' containment reference.
See Also:
getReservePhrase()

isAutomaticLockMode

boolean isAutomaticLockMode()
Deprecated. This was a superfluous method.

Returns the value of the 'Automatic Lock Mode' attribute.

Returns:
the value of the 'Automatic Lock Mode' attribute.
See Also:
setAutomaticLockMode(boolean), COBOLPackage.getFileControlEntry_AutomaticLockMode()

setAutomaticLockMode

void setAutomaticLockMode(boolean value)
Deprecated. This was a superfluous method.

Sets the value of the 'Automatic Lock Mode' attribute.

Parameters:
value - the new value of the 'Automatic Lock Mode' attribute.
See Also:
isAutomaticLockMode()

isWithLockOnRecord

boolean isWithLockOnRecord()
Deprecated. This was a superfluous method.

Returns the value of the 'With Lock On Record' attribute.

Returns:
the value of the 'With Lock On Record' attribute.
See Also:
setWithLockOnRecord(boolean), COBOLPackage.getFileControlEntry_WithLockOnRecord()

setWithLockOnRecord

void setWithLockOnRecord(boolean value)
Deprecated. This was a superfluous method.

Sets the value of the 'With Lock On Record' attribute.

Parameters:
value - the new value of the 'With Lock On Record' attribute.
See Also:
isWithLockOnRecord()

getPassword

AbstractDataItem getPassword()
Returns the value of the 'Password' reference.

The value is the data item specified in the PASSWORD clause.

Returns:
the value of the 'Password' reference.
See Also:
setPassword(AbstractDataItem), COBOLPackage.getFileControlEntry_Password()

setPassword

void setPassword(AbstractDataItem value)
Sets the value of the 'Password' reference.

Parameters:
value - the new value of the 'Password' reference.
See Also:
getPassword()

getStatus

AbstractDataItem getStatus()
Returns the value of the 'Status' reference.

The value is the file status key data item specified in the FILE STATUS clause. The optional second data item can be obtained using 'Platform Specific Status'.

Returns:
the value of the 'Status' reference.
See Also:
setStatus(AbstractDataItem), COBOLPackage.getFileControlEntry_Status()

setStatus

void setStatus(AbstractDataItem value)
Sets the value of the 'Status' reference.

Parameters:
value - the new value of the 'Status' reference.
See Also:
getStatus()

getPlatformSpecificStatus

AbstractDataItem getPlatformSpecificStatus()
Returns the value of the 'Platform Specific Status' reference.

The value is the second data item specified in the FILE STATUS clause, usually the data item that holds the VSAM return code.

Returns:
the value of the 'Platform Specific Status' reference.
See Also:
setPlatformSpecificStatus(AbstractDataItem), COBOLPackage.getFileControlEntry_PlatformSpecificStatus()

setPlatformSpecificStatus

void setPlatformSpecificStatus(AbstractDataItem value)
Sets the value of the 'Platform Specific Status' reference.

Parameters:
value - the new value of the 'Platform Specific Status' reference.
See Also:
getPlatformSpecificStatus()

getFileAccessModeClause

FileAccessModeClause getFileAccessModeClause()
Returns the value of the 'File Access Mode Clause' containment reference.

A representation of the file access mode clause. If this clause does not appear in the file control entry, null is returned.

Returns:
the value of the 'File Access Mode Clause' containment reference.
See Also:
setFileAccessModeClause(FileAccessModeClause), COBOLPackage.getFileControlEntry_FileAccessModeClause()

setFileAccessModeClause

void setFileAccessModeClause(FileAccessModeClause value)
Sets the value of the 'File Access Mode Clause' containment reference.

Parameters:
value - the new value of the 'File Access Mode Clause' containment reference.
See Also:
getFileAccessModeClause()

getAssignmentNames

java.util.List getAssignmentNames()
Returns the value of the 'Assignment Names' containment reference list. The list contents are of type AssignmentNameOrLiteral.

The list contains the assignment names and literals in the ASSIGN TO clause.

Returns:
the value of the 'Assignment Names' containment reference list.
See Also:
COBOLPackage.getFileControlEntry_AssignmentNames()