Interface | osid.blogging.EntryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving entries. This lookup session defines several views:
The methods Entries may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getBlogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Blog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlog | ||
Description |
Gets the | ||
Return | osid.blogging.Blog | the Blog associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupEntries | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeEntryView | ||
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 | usePlenaryEntryView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBlogView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in blogs which are children of this blog in the blog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBlogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this blog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | entryId | the Id of the Entry to retrieve |
Return | osid.blogging.Entry | the returned Entry | |
Errors | NOT_FOUND | no Entry found with the given Id | |
NULL_ARGUMENT | entryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntriesByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | entryIds | the list of Ids to retrieve |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | entryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntriesByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | entryGenusType | an entry genus type |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | NULL_ARGUMENT | entryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntriesByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | entryGenusType | an entry genus type |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | NULL_ARGUMENT | entryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntriesByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | entryRecordType | an entry record type |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | NULL_ARGUMENT | entryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntriesByDate | ||
Description |
Gets an | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | INVALID_ARGUMENT | to is less than from | |
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 | getEntriesForPoster | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a poster Id |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntriesByDateForPoster | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a poster Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.blogging.EntryList | the returned Entry list | |
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 | getEntriesByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.blogging.EntryList | the returned Entry list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntries | ||
Description |
Gets all | ||
Return | osid.blogging.EntryList | a list of Entries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |