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

Interface CicsDocumentRetrieveStmt

    • Method Detail

      • getDocToken

        DataRef getDocToken()
        Returns the value of the 'Doc Token' containment reference.

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

        Returns:
        the value of the 'Doc Token' containment reference.
        See Also:
        setDocToken(DataRef), COBOLPackage.getCicsDocumentRetrieveStmt_DocToken()
      • setDocToken

        void setDocToken(DataRef value)
        Sets the value of the 'Doc Token' containment reference.
        Parameters:
        value - the new value of the 'Doc Token' containment reference.
        See Also:
        getDocToken()
      • 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.

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

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

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

        Returns:
        the value of the 'Length' containment reference.
        See Also:
        setLength(DataRef), COBOLPackage.getCicsDocumentRetrieveStmt_Length()
      • setLength

        void setLength(DataRef value)
        Sets the value of the 'Length' containment reference.
        Parameters:
        value - the new value of the 'Length' containment reference.
        See Also:
        getLength()
      • 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.getCicsDocumentRetrieveStmt_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()
      • getCharacterSet

        DataRefOrLiteral getCharacterSet()
        Returns the value of the 'Character Set' containment reference.

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

        Returns:
        the value of the 'Character Set' containment reference.
        See Also:
        setCharacterSet(DataRefOrLiteral), COBOLPackage.getCicsDocumentRetrieveStmt_CharacterSet()
      • setCharacterSet

        void setCharacterSet(DataRefOrLiteral value)
        Sets the value of the 'Character Set' containment reference.
        Parameters:
        value - the new value of the 'Character Set' containment reference.
        See Also:
        getCharacterSet()
      • isDataOnly

        boolean isDataOnly()
        Returns the value of the 'Data Only' attribute.

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

        Returns:
        the value of the 'Data Only' attribute.
        See Also:
        setDataOnly(boolean), COBOLPackage.getCicsDocumentRetrieveStmt_DataOnly()
      • setDataOnly

        void setDataOnly(boolean value)
        Sets the value of the 'Data Only' attribute.
        Parameters:
        value - the new value of the 'Data Only' attribute.
        See Also:
        isDataOnly()
      • getClntCodePage

        DataRefOrLiteral getClntCodePage()
        Returns the value of the 'Clnt Code Page' containment reference.

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

        Returns:
        the value of the 'Clnt Code Page' containment reference.
        See Also:
        setClntCodePage(DataRefOrLiteral), COBOLPackage.getCicsDocumentRetrieveStmt_ClntCodePage()
      • setClntCodePage

        void setClntCodePage(DataRefOrLiteral value)
        Sets the value of the 'Clnt Code Page' containment reference.
        Parameters:
        value - the new value of the 'Clnt Code Page' containment reference.
        See Also:
        getClntCodePage()