OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.EntryLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving entries.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated blog view: All entry methods in this session operate, retrieve and pertain to entries defined explicitly in the current blog. Using an isolated view is useful for managing Entries with the EntryAdminSession.
  • federated blog view: All entry methods in this session operate, retrieve and pertain to all entries defined in this blog and any other entries implicitly available in this blog through blog inheritence.

The methods useFederatedBlogView() and useIsolatedBlogView() behave as a radio group and one should be selected before invoking any lookup methods.

Entries may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Entry.

MethodgetBlogId
Description

Gets the Blog Id associated with this session.

Returnosid.id.Idthe Blog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBlog
Description

Gets the Blog associated with this session.

Returnosid.blogging.Blogthe Blog associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupEntries
Description

Tests if this user can perform Entry lookups. 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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeEntryView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryEntryView
Description

A complete view of the Entry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedBlogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBlogView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this blog only.

CompliancemandatoryThis method is must be implemented.
MethodgetEntry
Description

Gets the Entry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Entry may have a different Id than requested, such as the case where a duplicate Id was assigned to a Entry and retained for compatibility.

Parametersosid.id.IdentryIdthe Id of the Entry to retrieve
Returnosid.blogging.Entrythe returned Entry
ErrorsNOT_FOUNDno Entry found with the given Id
NULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByIds
Description

Gets an EntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Entries may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListentryIdsthe list of Ids to retrieve
Returnosid.blogging.EntryListthe returned Entry list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT entryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByGenusType
Description

Gets an EntryList corresponding to the given entry genus Type which does not include entries of types derived from the specified Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.type.TypeentryGenusTypean entry genus type
Returnosid.blogging.EntryListthe returned Entry list
ErrorsNULL_ARGUMENT entryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByParentGenusType
Description

Gets an EntryList corresponding to the given entry genus Type and include any additional entries with genus types derived from the specified Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.type.TypeentryGenusTypean entry genus type
Returnosid.blogging.EntryListthe returned Entry list
ErrorsNULL_ARGUMENT entryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByRecordType
Description

Gets an EntryList containing the given entry record Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.blogging.EntryListthe returned Entry list
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByDate
Description

Gets an EntryList posted within the specified range inclusive. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.blogging.EntryListthe returned Entry list
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesForPoster
Description

Gets an EntryList for the given poster resource Id. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.id.IdresourceIda poster Id
Returnosid.blogging.EntryListthe returned Entry list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByDateForPoster
Description

Gets an EntryList for a poster resource Id posted within the specified range inclusive. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.id.IdresourceIda poster Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.blogging.EntryListthe returned Entry list
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByProvider
Description

Gets an EntryList for the given provider. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.blogging.EntryListthe returned Entry list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntries
Description

Gets all Entries. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Returnosid.blogging.EntryLista list of Entries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.