org.osid.blogging

Interface EntryLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface EntryLookupSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupEntries() Tests if this user can perform Entry lookups.
Blog	getBlog() Gets the Blog associated with this session.
Id	getBlogId() Gets the Blog Id associated with this session.
EntryList	getEntries() Gets all Entries.
EntryList	getEntriesByDate(DateTime from, DateTime to) Gets an EntryList posted within the specified range inclusive.
EntryList	getEntriesByDateForPoster(Id resourceId, DateTime from, DateTime to) Gets an EntryList for a poster resource Id posted within the specified range inclusive.
EntryList	getEntriesByGenusType(Type entryGenusType) Gets an EntryList corresponding to the given entry genus Type which does not include entries of types derived from the specified Type.
EntryList	getEntriesByIds(IdList entryIds) Gets an EntryList corresponding to the given IdList.
EntryList	getEntriesByParentGenusType(Type entryGenusType) Gets an EntryList corresponding to the given entry genus Type and include any additional entries with genus types derived from the specified Type.
EntryList	getEntriesByProvider(Id resourceId) Gets an EntryList for the given provider.
EntryList	getEntriesByRecordType(Type entryRecordType) Gets an EntryList containing the given entry record Type.
EntryList	getEntriesForPoster(Id resourceId) Gets an EntryList for the given poster resource Id.
Entry	getEntry(Id entryId) Gets the Entry specified by its Id.
void	useComparativeEntryView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedBlogView() Federates the view for methods in this session.
void	useIsolatedBlogView() Isolates the view for methods in this session.
void	usePlenaryEntryView() A complete view of the Entry returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBlogId

Id getBlogId()

Gets the Blog Id associated with this session.

Returns:

the Blog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBlog

Blog getBlog()
             throws OperationFailedException,
                    PermissionDeniedException

Gets the Blog associated with this session.

Returns:

the Blog associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupEntries

boolean canLookupEntries()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeEntryView

void useComparativeEntryView()

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.

usePlenaryEntryView

void usePlenaryEntryView()

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.

Compliance:

mandatory - This method is must be implemented.

useFederatedBlogView

void useFederatedBlogView()

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.

useIsolatedBlogView

void useIsolatedBlogView()

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.

getEntry

Entry getEntry(Id entryId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

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.

Parameters:

entryId - the Id of the Entry to retrieve

Returns:

the returned Entry

Throws:

NotFoundException - no Entry found with the given Id

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByIds

EntryList getEntriesByIds(IdList entryIds)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

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.

Parameters:

entryIds - the list of Ids to retrieve

Returns:

the returned Entry list

Throws:

NotFoundException - an Id was not found

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByGenusType

EntryList getEntriesByGenusType(Type entryGenusType)
                                throws OperationFailedException,
                                       PermissionDeniedException

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.

Parameters:

entryGenusType - an entry genus type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByParentGenusType

EntryList getEntriesByParentGenusType(Type entryGenusType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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.

Parameters:

entryGenusType - an entry genus type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByRecordType

EntryList getEntriesByRecordType(Type entryRecordType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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.

Parameters:

entryRecordType - an entry record type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByDate

EntryList getEntriesByDate(DateTime from,
                         DateTime to)
                           throws OperationFailedException,
                                  PermissionDeniedException

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.

Parameters:

from - starting date

to - ending date

Returns:

the returned Entry list

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesForPoster

EntryList getEntriesForPoster(Id resourceId)
                              throws OperationFailedException,
                                     PermissionDeniedException

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.

Parameters:

resourceId - a poster Id

Returns:

the returned Entry list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByDateForPoster

EntryList getEntriesByDateForPoster(Id resourceId,
                                  DateTime from,
                                  DateTime to)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Parameters:

resourceId - a poster Id

from - starting date

to - ending date

Returns:

the returned Entry list

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - resourceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByProvider

EntryList getEntriesByProvider(Id resourceId)
                               throws OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

resourceId - a resource Id

Returns:

the returned Entry list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntries

EntryList getEntries()
                     throws OperationFailedException,
                            PermissionDeniedException

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.

Returns:

a list of Entries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.