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

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

public interface ReadStmt
extends Stmt

A representation of a READ statement in the PROCEDURE division.

The following features are supported:

See Also:
COBOLPackage.getReadStmt()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List getAtEnd()
          Returns the value of the 'At End' containment reference list.
 ReadDirection getDirection()
          Returns the value of the 'Direction' attribute.
 FileDescriptionEntry getFile()
          Returns the value of the 'File' reference.
 DataRef getInto()
          Returns the value of the 'Into' containment reference.
 java.util.List getInvalidKey()
          Returns the value of the 'Invalid Key' containment reference list.
 DataRef getKey()
          Returns the value of the 'Key' containment reference.
 java.util.List getNotAtEnd()
          Returns the value of the 'Not At End' containment reference list.
 java.util.List getNotInvalidKey()
          Returns the value of the 'Not Invalid Key' containment reference list.
 boolean isEndReadUsed()
          Returns the value of the 'End Read Used' attribute.
 void setDirection(ReadDirection value)
          Sets the value of the 'Direction' attribute.
 void setEndReadUsed(boolean value)
          Sets the value of the 'End Read Used' attribute.
 void setFile(FileDescriptionEntry value)
          Sets the value of the 'File' reference.
 void setInto(DataRef value)
          Sets the value of the 'Into' containment reference.
 void setKey(DataRef value)
          Sets the value of the 'Key' containment reference.
 
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

getFile

FileDescriptionEntry getFile()
Returns the value of the 'File' reference.

Returns:
the value of the 'File' reference.
See Also:
setFile(FileDescriptionEntry), COBOLPackage.getReadStmt_File()

setFile

void setFile(FileDescriptionEntry value)
Sets the value of the 'File' reference.

Parameters:
value - the new value of the 'File' reference.
See Also:
getFile()

getDirection

ReadDirection getDirection()
Returns the value of the 'Direction' attribute. The literals are from the enumeration ReadDirection.

The value represents NEXT or PREVIOUS.

Returns:
the value of the 'Direction' attribute.
See Also:
ReadDirection, setDirection(ReadDirection), COBOLPackage.getReadStmt_Direction()

setDirection

void setDirection(ReadDirection value)
Sets the value of the 'Direction' attribute.

Parameters:
value - the new value of the 'Direction' attribute.
See Also:
ReadDirection, getDirection()

getInto

DataRef getInto()
Returns the value of the 'Into' containment reference.

The value is the data item in the INTO phrase.

Returns:
the value of the 'Into' containment reference.
See Also:
setInto(DataRef), COBOLPackage.getReadStmt_Into()

setInto

void setInto(DataRef value)
Sets the value of the 'Into' containment reference.

Parameters:
value - the new value of the 'Into' containment reference.
See Also:
getInto()

getKey

DataRef getKey()
Returns the value of the 'Key' containment reference.

The value is the data item in the KEY phrase.

Returns:
the value of the 'Key' containment reference.
See Also:
setKey(DataRef), COBOLPackage.getReadStmt_Key()

setKey

void setKey(DataRef value)
Sets the value of the 'Key' containment reference.

Parameters:
value - the new value of the 'Key' containment reference.
See Also:
getKey()

getAtEnd

java.util.List getAtEnd()
Returns the value of the 'At End' containment reference list. The list contents are of type Stmt.

The list contains the statements in the AT END phrase.

Returns:
the value of the 'At End' containment reference list.
See Also:
COBOLPackage.getReadStmt_AtEnd()

getNotAtEnd

java.util.List getNotAtEnd()
Returns the value of the 'Not At End' containment reference list. The list contents are of type Stmt.

The list contains the statements in the NOT AT END phrase.

Returns:
the value of the 'Not At End' containment reference list.
See Also:
COBOLPackage.getReadStmt_NotAtEnd()

getInvalidKey

java.util.List getInvalidKey()
Returns the value of the 'Invalid Key' containment reference list. The list contents are of type Stmt.

The list contains the statements in the INVALID KEY phrase.

Returns:
the value of the 'Invalid Key' containment reference list.
See Also:
COBOLPackage.getReadStmt_InvalidKey()

getNotInvalidKey

java.util.List getNotInvalidKey()
Returns the value of the 'Not Invalid Key' containment reference list. The list contents are of type Stmt.

The list contains the statements in the NOT INVALID KEY phrase.

Returns:
the value of the 'Not Invalid Key' containment reference list.
See Also:
COBOLPackage.getReadStmt_NotInvalidKey()

isEndReadUsed

boolean isEndReadUsed()
Returns the value of the 'End Read Used' attribute.

The value is true if END-READ is used; false otherwise.

Returns:
the value of the 'End Read Used' attribute.
See Also:
setEndReadUsed(boolean), COBOLPackage.getReadStmt_EndReadUsed()

setEndReadUsed

void setEndReadUsed(boolean value)
Sets the value of the 'End Read Used' attribute.

Parameters:
value - the new value of the 'End Read Used' attribute.
See Also:
isEndReadUsed()