com.jamasoftware.contour.ws.v2.domain
Class WsComment

java.lang.Object
  extended by com.jamasoftware.contour.ws.v2.domain.WsComment

public class WsComment
extends java.lang.Object

This object represents a Contour comment.

Author:
Dylan

Constructor Summary
WsComment()
          Creates an empty WsComment object.
WsComment(java.lang.String commentText, java.lang.Integer refId)
          Creates a new WsComment object with the given comment text and reference id values.
 
Method Summary
 java.lang.String getCommentText()
          Gets the text of the comment.
 java.util.Calendar getEntryDate()
          Gets the date the comment was made.
 java.lang.Long getId()
          Gets the comment's id.
 java.lang.Integer getRefId()
          Gets the comment's reference id.
 java.lang.Integer getScope()
          Gets the comment's scope.
 WsUser getUser()
          Gets the user who made the comment.
 void setCommentText(java.lang.String commentText)
          Sets the text of the comment.
 void setEntryDate(java.util.Calendar entryDate)
          Sets the date the comment was made.
 void setId(java.lang.Long id)
          Sets the comment's id.
 void setRefId(java.lang.Integer refId)
          Sets the comment's reference id.
 void setScope(java.lang.Integer scope)
          Sets the comment's scope.
 void setUser(WsUser user)
          Sets the user who made the comment.
 java.lang.String toString()
          Gets a string representation of this comment.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsComment

public WsComment()
Creates an empty WsComment object.


WsComment

public WsComment(java.lang.String commentText,
                 java.lang.Integer refId)
Creates a new WsComment object with the given comment text and reference id values.

Parameters:
commentText - text of the comment
refId - id of the document associated with the comment
Method Detail

getId

public java.lang.Long getId()
Gets the comment's id.

Returns:
the id

setId

public void setId(java.lang.Long id)
Sets the comment's id.

Parameters:
id - the id to set

getCommentText

public java.lang.String getCommentText()
Gets the text of the comment.

Returns:
the comment

setCommentText

public void setCommentText(java.lang.String commentText)
Sets the text of the comment.

Parameters:
commentText - the comment to set

getUser

public WsUser getUser()
Gets the user who made the comment.

Returns:
the user

setUser

public void setUser(WsUser user)
Sets the user who made the comment.

Parameters:
user - the user to set

getScope

public java.lang.Integer getScope()
Gets the comment's scope.

Returns:
the scope
See Also:
WsScope

setScope

public void setScope(java.lang.Integer scope)
Sets the comment's scope.

Parameters:
scope - the scope to set
See Also:
WsScope

getRefId

public java.lang.Integer getRefId()
Gets the comment's reference id.

Returns:
the reference id

setRefId

public void setRefId(java.lang.Integer refId)
Sets the comment's reference id.

Parameters:
refId - the reference id to set

getEntryDate

public java.util.Calendar getEntryDate()
Gets the date the comment was made.

Returns:
date of comment

setEntryDate

public void setEntryDate(java.util.Calendar entryDate)
Sets the date the comment was made.

Parameters:
entryDate - date of the comment

toString

public java.lang.String toString()
Gets a string representation of this comment.

Overrides:
toString in class java.lang.Object
Returns:
String


Copyright © 2010 Jama Software, Inc. All Rights Reserved.