oracle.alm.connector.data
Class CommentDef

java.lang.Object
  oracle.alm.connector.data.CommentDef

public class CommentDef
extends java.lang.Object

The CommentDef defines a work item comment. Comment can be defined declaratively in a connector model meta data file, which can be used in the connector code for create, update, or remove comments from the work item at runtime.

Following code shows how to access CommentDef in the code.

   CommentDef commentDef = widef.getCommentDef();
 

Since:

11.1.1.1.0

See Also:

WorkItemDef

Constructor Summary

CommentDef()
Sole constructor.

Method Summary

java.lang.String	getCriteriaRef() Retrieves the query criteria definition.
java.lang.String	getDataSource() Retrieves the data source name where the comments are maintained.
java.lang.String	getSourceAttrDef() Retrieves the field name that the work item comment is based on.
void	setCriteriaRef(java.lang.String criteriaRef) Sets the query criteria for the comment.
void	setDataSource(java.lang.String dataSource) Sets the data source where the comments are maintained.
void	setSourceAttrDef(java.lang.String srcAttr) Sets the field name to get the comment from.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommentDef

public CommentDef()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

setDataSource

public void setDataSource(java.lang.String dataSource)

Sets the data source where the comments are maintained.

Parameters:

dataSource - name of the data source

getDataSource

public java.lang.String getDataSource()

Retrieves the data source name where the comments are maintained.

Returns:

the data source for the work-item comment

setSourceAttrDef

public void setSourceAttrDef(java.lang.String srcAttr)

Sets the field name to get the comment from.

Parameters:

srcAttr - the source field name for the comment

getSourceAttrDef

public java.lang.String getSourceAttrDef()

Retrieves the field name that the work item comment is based on.

Returns:

the source field name for the comment

setCriteriaRef

public void setCriteriaRef(java.lang.String criteriaRef)

Sets the query criteria for the comment.

Parameters:

criteriaRef - the criteria applied on the datasource when getting data for the comment

getCriteriaRef

public java.lang.String getCriteriaRef()

Retrieves the query criteria definition.

Returns:

query criteria definition for the comment