org.eclipse.datatools.modelbase.sql.xml.query
Interface XMLValueFunctionComment

All Superinterfaces:
QueryValueExpression, SQLObject, SQLQueryObject, ValueExpression, ValueExpressionAtomic, ValueExpressionFunction, XMLValueFunction
All Known Implementing Classes:
XMLValueFunctionCommentImpl

public interface XMLValueFunctionComment
extends XMLValueFunction

A representation of the model object 'XML Value Function Comment'. Generates an XML comment value from a string expression. See ISO SQL/XML sec. 6.10.

The following features are supported:

See Also:
SQLXMLQueryModelPackage.getXMLValueFunctionComment()

Method Summary
 XMLValueFunctionCommentContent getCommentContent()
          Returns the value of the 'Comment Content' containment reference.
 XMLReturningType getReturningOption()
          Returns the value of the 'Returning Option' attribute.
 void setCommentContent(XMLValueFunctionCommentContent value)
          Sets the value of the 'Comment Content' containment reference.
 void setReturningOption(XMLReturningType value)
          Sets the value of the 'Returning Option' attribute.
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.query.ValueExpressionFunction
getFunction, getParameterList, isColumnFunction, isDistinct, isSpecialRegister, setColumnFunction, setDistinct, setFunction, setSpecialRegister
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.query.QueryValueExpression
getBasicLeft, getBasicRight, getBetweenLeft, getBetweenRight1, getBetweenRight2, getDataType, getGroupingExpr, getInValueListLeft, getInValueListRight, getInValueRowSelectLeft, getInValueSelectLeft, getLikeEscape, getLikeMatching, getLikePattern, getNest, getOrderByValueExpr, getPredicateNull, getQuantifiedRowSelectLeft, getQuantifiedValueSelectLeft, getResultColumn, getUnaryOperator, getUpdateSourceExprList, getValueExprCaseElse, getValueExprCaseSearchContent, getValueExprCaseSimple, getValueExprCaseSimpleContentResult, getValueExprCaseSimpleContentWhen, getValueExprCast, getValueExprCombinedLeft, getValueExprCombinedRight, getValueExprFunction, getValueExprLabeledDuration, getValuesRow, setBasicLeft, setBasicRight, setBetweenLeft, setBetweenRight1, setBetweenRight2, setDataType, setGroupingExpr, setInValueListLeft, setInValueListRight, setInValueRowSelectLeft, setInValueSelectLeft, setLikeEscape, setLikeMatching, setLikePattern, setNest, setOrderByValueExpr, setPredicateNull, setQuantifiedRowSelectLeft, setQuantifiedValueSelectLeft, setResultColumn, setUnaryOperator, setUpdateSourceExprList, setValueExprCaseElse, setValueExprCaseSearchContent, setValueExprCaseSimple, setValueExprCaseSimpleContentResult, setValueExprCaseSimpleContentWhen, setValueExprCast, setValueExprCombinedLeft, setValueExprCombinedRight, setValueExprFunction, setValueExprLabeledDuration, setValuesRow
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.query.SQLQueryObject
getSourceInfo, getSQL, setSourceInfo, setSQL
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.schema.SQLObject
addEAnnotation, addEAnnotationDetail, getComments, getDependencies, getDescription, getEAnnotation, getEAnnotationDetail, getLabel, getPrivileges, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.expressions.ValueExpression
getSQL, setSQL
 

Method Detail

getReturningOption

public XMLReturningType getReturningOption()
Returns the value of the 'Returning Option' attribute. The literals are from the enumeration XMLReturningType.

If the meaning of the 'Returning Option' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Returning Option' attribute.
See Also:
XMLReturningType, setReturningOption(XMLReturningType), SQLXMLQueryModelPackage.getXMLValueFunctionComment_ReturningOption()

setReturningOption

public void setReturningOption(XMLReturningType value)
Sets the value of the 'Returning Option' attribute.

Parameters:
value - the new value of the 'Returning Option' attribute.
See Also:
XMLReturningType, getReturningOption()

getCommentContent

public XMLValueFunctionCommentContent getCommentContent()
Returns the value of the 'Comment Content' containment reference. It is bidirectional and its opposite is 'Value Function Comment'.

If the meaning of the 'Comment Content' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Comment Content' containment reference.
See Also:
setCommentContent(XMLValueFunctionCommentContent), SQLXMLQueryModelPackage.getXMLValueFunctionComment_CommentContent(), XMLValueFunctionCommentContent.getValueFunctionComment()

setCommentContent

public void setCommentContent(XMLValueFunctionCommentContent value)
Sets the value of the 'Comment Content' containment reference.

Parameters:
value - the new value of the 'Comment Content' containment reference.
See Also:
getCommentContent()


Copyright © 2006 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.