Interface | osid.commenting.CommentLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving comments. This lookup session defines several views:
The methods | ||
Method | getBookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Book Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBook | ||
Description |
Gets the | ||
Return | osid.commenting.Book | the book | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupComments | ||
Description |
Tests if this user can examine this book. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this
session will result in a | ||
Return | boolean | false if book reading methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCommentView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCommentView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBookView | ||
Description |
Federates the view for methods in this session. A federated view will include comments in books which are children of this book in the book hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this book only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveCommentView | ||
Description |
Only comments whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveCommentView | ||
Description |
All comments of any effective dates are returned by all methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getComment | ||
Description |
Gets the In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | commentId | the Id of the Comment to retrieve |
Return | osid.commenting.Comment | the returned Comment | |
Errors | NOT_FOUND | no Comment found with the given Id | |
NULL_ARGUMENT | commentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByIds | ||
Description |
Gets a In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.IdList | commentIds | the list of Ids to retrieve |
Return | osid.commenting.CommentList | the returned Comment list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | commentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusType | ||
Description |
Gets a In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.type.Type | commentGenusType | a comment genus type |
Return | osid.commenting.CommentList | the returned Comment list | |
Errors | NULL_ARGUMENT | commentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByParentGenusType | ||
Description |
Gets a In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.type.Type | commentGenusType | a comment genus type |
Return | osid.commenting.CommentList | the returned Comment list | |
Errors | NULL_ARGUMENT | commentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByRecordType | ||
Description |
Gets a In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.type.Type | commentRecordType | a comment record type |
Return | osid.commenting.CommentList | the returned Comment list | |
Errors | NULL_ARGUMENT | commentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.commenting.CommentList | the returned Comment list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.type.Type | commentGenusType | a comment genus type |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.commenting.CommentList | the returned Comment list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | commentGenusType, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsForCommentor | ||
Description |
Gets a list of comments corresponding to a resource
In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsForCommentorOnDate | ||
Description |
Gets a list of all comments corresponding to a resource
In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeForCommentor | ||
Description |
Gets a list of comments of the given genus type
corresponding to a resource In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.type.Type | commentGenusType | the comment genus type | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | NULL_ARGUMENT | resourceId or commentGenusType is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeForCommentorOnDate | ||
Description |
Gets a list of all comments of the given genus type
corresponding to a resource In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.type.Type | commentGenusType | the comment genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, commentGenusType, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsForReference | ||
Description |
Gets a list of comments corresponding to a reference
In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | referenceId | the Id of the reference |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsForReferenceOnDate | ||
Description |
Gets a list of all comments corresponding to a
reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | referenceId | a reference Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | referenceId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeForReference | ||
Description |
Gets a list of comments of the given genus type
corresponding to a reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | referenceId | the Id of the reference |
osid.type.Type | commentGenusType | the comment genus type | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | NULL_ARGUMENT | referenceId or commentGenusType is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeForReferenceOnDate | ||
Description |
Gets a list of all comments of the given genus type
corresponding to a reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | referenceId | a reference Id |
osid.type.Type | commentGenusType | the comment genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | referenceId, commentGenusType, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsForCommentorAndReference | ||
Description |
Gets a list of comments corresponding to a resource and
reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | referenceId | the Id of the reference | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | NULL_ARGUMENT | resourceId or referenceId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsForCommentorAndReferenceOnDate | ||
Description |
Gets a list of all comments corresponding to a resource
and reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | referenceId | a reference Id | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, referenceId, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeForCommentorAndReference | ||
Description |
Gets a list of comments of the given genus type
corresponding to a resource and reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | referenceId | the Id of the reference | |
osid.type.Type | commentGenusType | the comment genus type | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | NULL_ARGUMENT | resourceId, referenceId or commentGenusType
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommentsByGenusTypeForCommentorAndReferenceOnDate | ||
Description |
Gets a list of all comments corresponding to a resource
and reference In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | referenceId | a reference Id | |
osid.type.Type | commentGenusType | the comment genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.commenting.CommentList | the returned CommentList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, referenceId, commentGenusType, from, or
to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getComments | ||
Description |
Gets all comments. In plenary mode, the returned list contains all known comments or an error results. Otherwise, the returned list may contain only those comments that are accessible through this session. In effective mode, comments are returned that are currently effective. In any effective mode, effective comments and those currently expired are returned. | ||
Return | osid.commenting.CommentList | a list of comments | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |