com.ibm.etools.cobol.application.model.cobol

Interface CicsConverseStmt

    • Method Detail

      • getFrom

        DataRef getFrom()
        Returns the value of the 'From' containment reference.

        The value is a representation of the data area specified in the FROM option.

        Returns:
        the value of the 'From' containment reference.
        See Also:
        setFrom(DataRef), COBOLPackage.getCicsConverseStmt_From()
      • setFrom

        void setFrom(DataRef value)
        Sets the value of the 'From' containment reference.
        Parameters:
        value - the new value of the 'From' containment reference.
        See Also:
        getFrom()
      • getFromLength

        DataRefOrLiteral getFromLength()
        Returns the value of the 'From Length' containment reference.

        The value is a representation of the data value specified in the FROMLENGTH option; if that option is not used, the value is null.

        Returns:
        the value of the 'From Length' containment reference.
        See Also:
        setFromLength(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_FromLength()
      • setFromLength

        void setFromLength(DataRefOrLiteral value)
        Sets the value of the 'From Length' containment reference.
        Parameters:
        value - the new value of the 'From Length' containment reference.
        See Also:
        getFromLength()
      • getFromFLength

        DataRefOrLiteral getFromFLength()
        Returns the value of the 'From FLength' containment reference.

        The value is a representation of the data value specified in the FROMFLENGTH option; if that option is not used, the value is null.

        Returns:
        the value of the 'From FLength' containment reference.
        See Also:
        setFromFLength(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_FromFLength()
      • setFromFLength

        void setFromFLength(DataRefOrLiteral value)
        Sets the value of the 'From FLength' containment reference.
        Parameters:
        value - the new value of the 'From FLength' containment reference.
        See Also:
        getFromFLength()
      • getInto

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

        The value is a representation of the data area specified in the INTO option; if that option is not used, the value is null.

        Returns:
        the value of the 'Into' containment reference.
        See Also:
        setInto(DataRef), COBOLPackage.getCicsConverseStmt_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()
      • getSet

        DataRef getSet()
        Returns the value of the 'Set' containment reference.

        The value is a representation of the pointer reference specified in the SET option; if that option is not used, the value is null.

        Returns:
        the value of the 'Set' containment reference.
        See Also:
        setSet(DataRef), COBOLPackage.getCicsConverseStmt_Set()
      • setSet

        void setSet(DataRef value)
        Sets the value of the 'Set' containment reference.
        Parameters:
        value - the new value of the 'Set' containment reference.
        See Also:
        getSet()
      • getToLength

        DataRef getToLength()
        Returns the value of the 'To Length' containment reference.

        The value is a representation of the data area specified in the TOLENGTH option; if that option is not used, the value is null.

        Returns:
        the value of the 'To Length' containment reference.
        See Also:
        setToLength(DataRef), COBOLPackage.getCicsConverseStmt_ToLength()
      • setToLength

        void setToLength(DataRef value)
        Sets the value of the 'To Length' containment reference.
        Parameters:
        value - the new value of the 'To Length' containment reference.
        See Also:
        getToLength()
      • getToFLength

        DataRef getToFLength()
        Returns the value of the 'To FLength' containment reference.

        The value is a representation of the data area specified in the TOFLENGTH option; if that option is not used, the value is null.

        Returns:
        the value of the 'To FLength' containment reference.
        See Also:
        setToFLength(DataRef), COBOLPackage.getCicsConverseStmt_ToFLength()
      • setToFLength

        void setToFLength(DataRef value)
        Sets the value of the 'To FLength' containment reference.
        Parameters:
        value - the new value of the 'To FLength' containment reference.
        See Also:
        getToFLength()
      • getMaxLength

        DataRefOrLiteral getMaxLength()
        Returns the value of the 'Max Length' containment reference.

        The value is a representation of the data value specified in the MAXLENGTH option; if that option is not used, the value is null.

        Returns:
        the value of the 'Max Length' containment reference.
        See Also:
        setMaxLength(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_MaxLength()
      • setMaxLength

        void setMaxLength(DataRefOrLiteral value)
        Sets the value of the 'Max Length' containment reference.
        Parameters:
        value - the new value of the 'Max Length' containment reference.
        See Also:
        getMaxLength()
      • getMaxFLength

        DataRefOrLiteral getMaxFLength()
        Returns the value of the 'Max FLength' containment reference.

        The value is a representation of the data value specified in the MAXFLENGTH option; if that option is not used, the value is null.

        Returns:
        the value of the 'Max FLength' containment reference.
        See Also:
        setMaxFLength(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_MaxFLength()
      • setMaxFLength

        void setMaxFLength(DataRefOrLiteral value)
        Sets the value of the 'Max FLength' containment reference.
        Parameters:
        value - the new value of the 'Max FLength' containment reference.
        See Also:
        getMaxFLength()
      • isNoTruncate

        boolean isNoTruncate()
        Returns the value of the 'No Truncate' attribute.

        The value is true if the NOTRUNCATE option is used; false otherwise.

        Returns:
        the value of the 'No Truncate' attribute.
        See Also:
        setNoTruncate(boolean), COBOLPackage.getCicsConverseStmt_NoTruncate()
      • setNoTruncate

        void setNoTruncate(boolean value)
        Sets the value of the 'No Truncate' attribute.
        Parameters:
        value - the new value of the 'No Truncate' attribute.
        See Also:
        isNoTruncate()
      • getConvId

        DataRefOrLiteral getConvId()
        Returns the value of the 'Conv Id' containment reference.

        The value is a representation of the name specified in the CONVID option; if that option is not used, the value is null.

        Returns:
        the value of the 'Conv Id' containment reference.
        See Also:
        setConvId(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_ConvId()
      • setConvId

        void setConvId(DataRefOrLiteral value)
        Sets the value of the 'Conv Id' containment reference.
        Parameters:
        value - the new value of the 'Conv Id' containment reference.
        See Also:
        getConvId()
      • getState

        DataRef getState()
        Returns the value of the 'State' containment reference.

        The value is a representation of the CICS value data area specified in the STATE option; if that option is not used, the value is null.

        Returns:
        the value of the 'State' containment reference.
        See Also:
        setState(DataRef), COBOLPackage.getCicsConverseStmt_State()
      • setState

        void setState(DataRef value)
        Sets the value of the 'State' containment reference.
        Parameters:
        value - the new value of the 'State' containment reference.
        See Also:
        getState()
      • isErase

        boolean isErase()
        Returns the value of the 'Erase' attribute.

        The value is true if the ERASE option is present; false otherwise.

        Returns:
        the value of the 'Erase' attribute.
        See Also:
        setErase(boolean), COBOLPackage.getCicsConverseStmt_Erase()
      • setErase

        void setErase(boolean value)
        Sets the value of the 'Erase' attribute.
        Parameters:
        value - the new value of the 'Erase' attribute.
        See Also:
        isErase()
      • isDefault

        boolean isDefault()
        Returns the value of the 'Default' attribute.

        The value is true if the DEFAULT option is present; false otherwise.

        Returns:
        the value of the 'Default' attribute.
        See Also:
        setDefault(boolean), COBOLPackage.getCicsConverseStmt_Default()
      • setDefault

        void setDefault(boolean value)
        Sets the value of the 'Default' attribute.
        Parameters:
        value - the new value of the 'Default' attribute.
        See Also:
        isDefault()
      • isAlternate

        boolean isAlternate()
        Returns the value of the 'Alternate' attribute.

        The value is true if the ALTERNATE option is present; false otherwise.

        Returns:
        the value of the 'Alternate' attribute.
        See Also:
        setAlternate(boolean), COBOLPackage.getCicsConverseStmt_Alternate()
      • setAlternate

        void setAlternate(boolean value)
        Sets the value of the 'Alternate' attribute.
        Parameters:
        value - the new value of the 'Alternate' attribute.
        See Also:
        isAlternate()
      • getCtlChar

        DataRefOrLiteral getCtlChar()
        Returns the value of the 'Ctl Char' containment reference.

        The value is a representation of the data value specified in the CTLCHAR option; if that option is not used, the value is null.

        Returns:
        the value of the 'Ctl Char' containment reference.
        See Also:
        setCtlChar(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_CtlChar()
      • setCtlChar

        void setCtlChar(DataRefOrLiteral value)
        Sets the value of the 'Ctl Char' containment reference.
        Parameters:
        value - the new value of the 'Ctl Char' containment reference.
        See Also:
        getCtlChar()
      • isStrField

        boolean isStrField()
        Returns the value of the 'Str Field' attribute.

        The value is true if the STRFIELD option is used; false otherwise.

        Returns:
        the value of the 'Str Field' attribute.
        See Also:
        setStrField(boolean), COBOLPackage.getCicsConverseStmt_StrField()
      • setStrField

        void setStrField(boolean value)
        Sets the value of the 'Str Field' attribute.
        Parameters:
        value - the new value of the 'Str Field' attribute.
        See Also:
        isStrField()
      • isDEFResp

        boolean isDEFResp()
        Returns the value of the 'DEF Resp' attribute.

        The value is true if the DEFRESP option is used; false otherwise.

        Returns:
        the value of the 'DEF Resp' attribute.
        See Also:
        setDEFResp(boolean), COBOLPackage.getCicsConverseStmt_DEFResp()
      • setDEFResp

        void setDEFResp(boolean value)
        Sets the value of the 'DEF Resp' attribute.
        Parameters:
        value - the new value of the 'DEF Resp' attribute.
        See Also:
        isDEFResp()
      • isAsIs

        boolean isAsIs()
        Returns the value of the 'As Is' attribute.

        The value is true if the ASIS option is used; false otherwise.

        Returns:
        the value of the 'As Is' attribute.
        See Also:
        setAsIs(boolean), COBOLPackage.getCicsConverseStmt_AsIs()
      • setAsIs

        void setAsIs(boolean value)
        Sets the value of the 'As Is' attribute.
        Parameters:
        value - the new value of the 'As Is' attribute.
        See Also:
        isAsIs()
      • isFMH

        boolean isFMH()
        Returns the value of the 'FMH' attribute.

        The value is true if the FMH option is used; false otherwise.

        Returns:
        the value of the 'FMH' attribute.
        See Also:
        setFMH(boolean), COBOLPackage.getCicsConverseStmt_FMH()
      • setFMH

        void setFMH(boolean value)
        Sets the value of the 'FMH' attribute.
        Parameters:
        value - the new value of the 'FMH' attribute.
        See Also:
        isFMH()
      • getSession

        DataRefOrLiteral getSession()
        Returns the value of the 'Session' containment reference.

        The value is a representation of the name specified in the SESSION option; if that option is not used, the value is null.

        Returns:
        the value of the 'Session' containment reference.
        See Also:
        setSession(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_Session()
      • setSession

        void setSession(DataRefOrLiteral value)
        Sets the value of the 'Session' containment reference.
        Parameters:
        value - the new value of the 'Session' containment reference.
        See Also:
        getSession()
      • getAttachId

        DataRefOrLiteral getAttachId()
        Returns the value of the 'Attach Id' containment reference.

        The value is a representation of the name specified in the ATTACHID option; if that option is not used, the value is null.

        Returns:
        the value of the 'Attach Id' containment reference.
        See Also:
        setAttachId(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_AttachId()
      • setAttachId

        void setAttachId(DataRefOrLiteral value)
        Sets the value of the 'Attach Id' containment reference.
        Parameters:
        value - the new value of the 'Attach Id' containment reference.
        See Also:
        getAttachId()
      • getLDC

        DataRefOrLiteral getLDC()
        Returns the value of the 'LDC' containment reference.

        The value is a representation of the name specified in the LDC option; if that option is not used, the value is null.

        Returns:
        the value of the 'LDC' containment reference.
        See Also:
        setLDC(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_LDC()
      • setLDC

        void setLDC(DataRefOrLiteral value)
        Sets the value of the 'LDC' containment reference.
        Parameters:
        value - the new value of the 'LDC' containment reference.
        See Also:
        getLDC()
      • getLineAddr

        DataRefOrLiteral getLineAddr()
        Returns the value of the 'Line Addr' containment reference.

        The value is a representation of the data value specified in the LINEADDR option; if that option is not used, the value is null.

        Returns:
        the value of the 'Line Addr' containment reference.
        See Also:
        setLineAddr(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_LineAddr()
      • setLineAddr

        void setLineAddr(DataRefOrLiteral value)
        Sets the value of the 'Line Addr' containment reference.
        Parameters:
        value - the new value of the 'Line Addr' containment reference.
        See Also:
        getLineAddr()
      • isLeaveKB

        boolean isLeaveKB()
        Returns the value of the 'Leave KB' attribute.

        The value is true if the LEAVEKB option is used; false otherwise.

        Returns:
        the value of the 'Leave KB' attribute.
        See Also:
        setLeaveKB(boolean), COBOLPackage.getCicsConverseStmt_LeaveKB()
      • setLeaveKB

        void setLeaveKB(boolean value)
        Sets the value of the 'Leave KB' attribute.
        Parameters:
        value - the new value of the 'Leave KB' attribute.
        See Also:
        isLeaveKB()
      • getDest

        DataRefOrLiteral getDest()
        Returns the value of the 'Dest' containment reference.

        The value is a representation of the name specified in the DEST option; if that option is not used, the value is null.

        Returns:
        the value of the 'Dest' containment reference.
        See Also:
        setDest(DataRefOrLiteral), COBOLPackage.getCicsConverseStmt_Dest()
      • setDest

        void setDest(DataRefOrLiteral value)
        Sets the value of the 'Dest' containment reference.
        Parameters:
        value - the new value of the 'Dest' containment reference.
        See Also:
        getDest()
      • isPseudoBin

        boolean isPseudoBin()
        Returns the value of the 'Pseudo Bin' attribute.

        The value is true if the PSEUDOBIN option is used; false otherwise.

        Returns:
        the value of the 'Pseudo Bin' attribute.
        See Also:
        setPseudoBin(boolean), COBOLPackage.getCicsConverseStmt_PseudoBin()
      • setPseudoBin

        void setPseudoBin(boolean value)
        Sets the value of the 'Pseudo Bin' attribute.
        Parameters:
        value - the new value of the 'Pseudo Bin' attribute.
        See Also:
        isPseudoBin()