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

Interface CicsDocumentCreateStmt

    • 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.getCicsDocumentCreateStmt_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()
      • 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; if that option is not used, the value is null.

        Returns:
        the value of the 'From' containment reference.
        See Also:
        setFrom(DataRef), COBOLPackage.getCicsDocumentCreateStmt_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()
      • getText

        DataRef getText()
        Returns the value of the 'Text' containment reference.

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

        Returns:
        the value of the 'Text' containment reference.
        See Also:
        setText(DataRef), COBOLPackage.getCicsDocumentCreateStmt_Text()
      • setText

        void setText(DataRef value)
        Sets the value of the 'Text' containment reference.
        Parameters:
        value - the new value of the 'Text' containment reference.
        See Also:
        getText()
      • getBinary

        DataRef getBinary()
        Returns the value of the 'Binary' containment reference.

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

        Returns:
        the value of the 'Binary' containment reference.
        See Also:
        setBinary(DataRef), COBOLPackage.getCicsDocumentCreateStmt_Binary()
      • setBinary

        void setBinary(DataRef value)
        Sets the value of the 'Binary' containment reference.
        Parameters:
        value - the new value of the 'Binary' containment reference.
        See Also:
        getBinary()
      • getLength

        DataRefOrLiteral 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(DataRefOrLiteral), COBOLPackage.getCicsDocumentCreateStmt_Length()
      • setLength

        void setLength(DataRefOrLiteral value)
        Sets the value of the 'Length' containment reference.
        Parameters:
        value - the new value of the 'Length' containment reference.
        See Also:
        getLength()
      • getFromDoc

        DataRefOrLiteral getFromDoc()
        Returns the value of the 'From Doc' containment reference.

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

        Returns:
        the value of the 'From Doc' containment reference.
        See Also:
        setFromDoc(DataRefOrLiteral), COBOLPackage.getCicsDocumentCreateStmt_FromDoc()
      • setFromDoc

        void setFromDoc(DataRefOrLiteral value)
        Sets the value of the 'From Doc' containment reference.
        Parameters:
        value - the new value of the 'From Doc' containment reference.
        See Also:
        getFromDoc()
      • getTemplate

        DataRefOrLiteral getTemplate()
        Returns the value of the 'Template' containment reference.

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

        Returns:
        the value of the 'Template' containment reference.
        See Also:
        setTemplate(DataRefOrLiteral), COBOLPackage.getCicsDocumentCreateStmt_Template()
      • setTemplate

        void setTemplate(DataRefOrLiteral value)
        Sets the value of the 'Template' containment reference.
        Parameters:
        value - the new value of the 'Template' containment reference.
        See Also:
        getTemplate()
      • getSymbolList

        DataRef getSymbolList()
        Returns the value of the 'Symbol List' containment reference.

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

        Returns:
        the value of the 'Symbol List' containment reference.
        See Also:
        setSymbolList(DataRef), COBOLPackage.getCicsDocumentCreateStmt_SymbolList()
      • setSymbolList

        void setSymbolList(DataRef value)
        Sets the value of the 'Symbol List' containment reference.
        Parameters:
        value - the new value of the 'Symbol List' containment reference.
        See Also:
        getSymbolList()
      • getListLength

        DataRefOrLiteral getListLength()
        Returns the value of the 'List Length' containment reference.

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

        Returns:
        the value of the 'List Length' containment reference.
        See Also:
        setListLength(DataRefOrLiteral), COBOLPackage.getCicsDocumentCreateStmt_ListLength()
      • setListLength

        void setListLength(DataRefOrLiteral value)
        Sets the value of the 'List Length' containment reference.
        Parameters:
        value - the new value of the 'List Length' containment reference.
        See Also:
        getListLength()
      • getDelimiter

        DataRefOrLiteral getDelimiter()
        Returns the value of the 'Delimiter' containment reference.

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

        Returns:
        the value of the 'Delimiter' containment reference.
        See Also:
        setDelimiter(DataRefOrLiteral), COBOLPackage.getCicsDocumentCreateStmt_Delimiter()
      • setDelimiter

        void setDelimiter(DataRefOrLiteral value)
        Sets the value of the 'Delimiter' containment reference.
        Parameters:
        value - the new value of the 'Delimiter' containment reference.
        See Also:
        getDelimiter()
      • isUnescaped

        boolean isUnescaped()
        Returns the value of the 'Unescaped' attribute.

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

        Returns:
        the value of the 'Unescaped' attribute.
        See Also:
        setUnescaped(boolean), COBOLPackage.getCicsDocumentCreateStmt_Unescaped()
      • setUnescaped

        void setUnescaped(boolean value)
        Sets the value of the 'Unescaped' attribute.
        Parameters:
        value - the new value of the 'Unescaped' attribute.
        See Also:
        isUnescaped()
      • getDocSize

        DataRef getDocSize()
        Returns the value of the 'Doc Size' containment reference.

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

        Returns:
        the value of the 'Doc Size' containment reference.
        See Also:
        setDocSize(DataRef), COBOLPackage.getCicsDocumentCreateStmt_DocSize()
      • setDocSize

        void setDocSize(DataRef value)
        Sets the value of the 'Doc Size' containment reference.
        Parameters:
        value - the new value of the 'Doc Size' containment reference.
        See Also:
        getDocSize()
      • getHostCodePage

        DataRefOrLiteral getHostCodePage()
        Returns the value of the 'Host Code Page' containment reference.

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

        Returns:
        the value of the 'Host Code Page' containment reference.
        See Also:
        setHostCodePage(DataRefOrLiteral), COBOLPackage.getCicsDocumentCreateStmt_HostCodePage()
      • setHostCodePage

        void setHostCodePage(DataRefOrLiteral value)
        Sets the value of the 'Host Code Page' containment reference.
        Parameters:
        value - the new value of the 'Host Code Page' containment reference.
        See Also:
        getHostCodePage()
      • isPrivate

        boolean isPrivate()
        Returns the value of the 'Private' attribute.

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

        Returns:
        the value of the 'Private' attribute.
        See Also:
        setPrivate(boolean), COBOLPackage.getCicsDocumentCreateStmt_Private()
      • setPrivate

        void setPrivate(boolean value)
        Sets the value of the 'Private' attribute.
        Parameters:
        value - the new value of the 'Private' attribute.
        See Also:
        isPrivate()