org.kuali.student.common.ui.client.service
Interface CommentRpcServiceAsync

All Superinterfaces:

BaseRpcServiceAsync

public interface CommentRpcServiceAsync
extends BaseRpcServiceAsync

Method Summary

void	addComment(String referenceId, String referenceTypeKey, CommentInfo commentInfo, com.google.gwt.user.client.rpc.AsyncCallback<CommentInfo> callback) Adds a comment to a reference.
void	getComments(String referenceId, String referenceTypeKey, com.google.gwt.user.client.rpc.AsyncCallback<List<CommentInfo>> callback) Retrieves comment information for a reference.
void	getCommentsByType(String referenceId, String referenceTypeKey, String commentTypeKey, com.google.gwt.user.client.rpc.AsyncCallback<List<CommentInfo>> callback) Retrieves comment information for a reference of a particular type.
void	getCommentTypesForReferenceType(String referenceTypeKey, com.google.gwt.user.client.rpc.AsyncCallback<List<CommentTypeInfo>> callback) Gets the comment types for a particular reference type.
void	getUserRealName(String userId, com.google.gwt.user.client.rpc.AsyncCallback<String> callback) user IdentityService to get user name
void	isAuthorizedAddComment(String id, String referenceTypeKey, com.google.gwt.user.client.rpc.AsyncCallback<Boolean> callback) Check for authorization to add a comment
void	removeComment(String commentId, String referenceId, String referenceTypeKey, com.google.gwt.user.client.rpc.AsyncCallback<StatusInfo> callback) Removes a comment.
void	updateComment(String referenceId, String referenceTypeKey, CommentInfo commentInfo, com.google.gwt.user.client.rpc.AsyncCallback<CommentInfo> callback) Updates a comment for a reference.

Methods inherited from interface org.kuali.student.common.ui.client.service.BaseRpcServiceAsync

getObjectStructure, getObjectTypes, getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search

Method Detail

addComment

void addComment(String referenceId,
                String referenceTypeKey,
                CommentInfo commentInfo,
                com.google.gwt.user.client.rpc.AsyncCallback<CommentInfo> callback)
                throws Exception

Adds a comment to a reference.

Parameters:

referenceId - identifier of reference

referenceTypeKey - reference type

commentInfo - detailed information about the comment

detailed - information about the comment

Throws:

Exception

getComments

void getComments(String referenceId,
                 String referenceTypeKey,
                 com.google.gwt.user.client.rpc.AsyncCallback<List<CommentInfo>> callback)
                 throws Exception

Retrieves comment information for a reference. The expected behavior is that if the caller is not authorized to invoke the getComments operation, a PERMISSION_DENIED error is returned. Assuming that the caller is authorized to invoke getComments, only comments that the caller is authorized to view are included in the returned commentInfoList; comments that the caller is unauthorized to view are filtered out of the return parameter.

Parameters:

referenceId - reference identifier

referenceTypeKey - reference type

list - of comment information

Throws:

Exception

getCommentsByType

void getCommentsByType(String referenceId,
                       String referenceTypeKey,
                       String commentTypeKey,
                       com.google.gwt.user.client.rpc.AsyncCallback<List<CommentInfo>> callback)
                       throws Exception

Retrieves comment information for a reference of a particular type. The expected behavior is that if the caller is not authorized to invoke the getCommentsByType operation, a PERMISSION_DENIED error is returned. Assuming that the caller is authorized to invoke getCommentsByType, only comments that the caller is authorized to view are included in the returned commentInfoList; comments that the caller is unauthorized to view are filtered out of the return parameter.

Parameters:

referenceId - reference identifier

referenceTypeKey - reference type

commentTypeKey - comment type

list - of comment information

Throws:

Exception

updateComment

void updateComment(String referenceId,
                   String referenceTypeKey,
                   CommentInfo commentInfo,
                   com.google.gwt.user.client.rpc.AsyncCallback<CommentInfo> callback)
                   throws Exception

Updates a comment for a reference.

Parameters:

referenceId - identifier of reference

referenceTypeKey - reference type

commentInfo - detailed information about the comment

detailed - information about the comment

Throws:

Exception

removeComment

void removeComment(String commentId,
                   String referenceId,
                   String referenceTypeKey,
                   com.google.gwt.user.client.rpc.AsyncCallback<StatusInfo> callback)
                   throws Exception

Removes a comment.

Parameters:

commentId - id of comment to be removed

referenceId - identifier of reference

referenceTypeKey - reference type

Throws:

Exception

getCommentTypesForReferenceType

void getCommentTypesForReferenceType(String referenceTypeKey,
                                     com.google.gwt.user.client.rpc.AsyncCallback<List<CommentTypeInfo>> callback)
                                     throws Exception

Gets the comment types for a particular reference type.

Parameters:

referenceTypeKey - reference type

Throws:

Exception

isAuthorizedAddComment

void isAuthorizedAddComment(String id,
                            String referenceTypeKey,
                            com.google.gwt.user.client.rpc.AsyncCallback<Boolean> callback)

Check for authorization to add a comment

Parameters:

id - identifier of the object related to the reference type key

referenceTypeKey - reference type key of the object the comment is being set on

getUserRealName

void getUserRealName(String userId,
                     com.google.gwt.user.client.rpc.AsyncCallback<String> callback)

user IdentityService to get user name

Parameters:

userId -

callback -