public interface JournalLookupSession extends OsidSession
This session provides methods for retrieving Journal
objects. The Journal
represents a collection of journal
entries.
This session defines views that offer differing behaviors when retrieving multiple objects.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupJournals()
Tests if this user can perform
Journal lookups. |
Journal |
getJournal(Id journalId)
Gets the
Journal specified by its Id. |
JournalList |
getJournals()
Gets all
Journals. |
JournalList |
getJournalsByGenusType(Type journalGenusType)
Gets a
JournalList corresponding to the given journal
genus Type which does not include journals of genus
types derived from the specified Type. |
JournalList |
getJournalsByIds(IdList journalIds)
Gets a
JournalList corresponding to the given
IdList. |
JournalList |
getJournalsByParentGenusType(Type journalGenusType)
Gets a
JournalList corresponding to the given journal
genus Type and include any additional journals with
genus types derived from the specified Type. |
JournalList |
getJournalsByProvider(Id resourceId)
Gets a
JournalList for the given provider. |
JournalList |
getJournalsByRecordType(Type journalRecordType)
Gets a
JournalList containing the given journal record
Type. |
void |
useComparativeJournalView()
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 |
usePlenaryJournalView()
A complete view of the
Journal returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupJournals()
Journal
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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeJournalView()
mandatory
- This method is must be implemented. void usePlenaryJournalView()
Journal
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.mandatory
- This method is must be implemented. Journal getJournal(Id journalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Journal
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Journal
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Journal
and retained for compatibility.journalId
- Id
of the Journal
NotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. JournalList getJournalsByIds(IdList journalIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
JournalList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
journals 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 Journals
may be omitted from the list and
may present the elements in any order including returning a unique
set.journalIds
- the list of Ids
to retrieve Journal
listNotFoundException
- an Id was
not foundNullArgumentException
- journalIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalList getJournalsByGenusType(Type journalGenusType) throws OperationFailedException, PermissionDeniedException
JournalList
corresponding to the given journal
genus Type
which does not include journals of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known journals or an error results.
Otherwise, the returned list may contain only those journals that are
accessible through this session.journalGenusType
- a journal genus type Journal
listNullArgumentException
- journalGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalList getJournalsByParentGenusType(Type journalGenusType) throws OperationFailedException, PermissionDeniedException
JournalList
corresponding to the given journal
genus Type
and include any additional journals with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known journals or an error
results. Otherwise, the returned list may contain only those journals
that are accessible through this session.journalGenusType
- a journal genus type Journal
listNullArgumentException
- journalGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalList getJournalsByRecordType(Type journalRecordType) throws OperationFailedException, PermissionDeniedException
JournalList
containing the given journal record
Type.
In plenary mode, the returned list contains all
known journals or an error results. Otherwise, the returned list may
contain only those journals that are accessible through this session.journalRecordType
- a journal record type Journal
listNullArgumentException
- journalRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalList getJournalsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
JournalList
for the given provider.
In plenary mode, the returned list contains all known journals
or an error results. Otherwise, the returned list may contain only
those journals that are accessible through this session.resourceId
- a resource Id
Journal
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalList getJournals() throws OperationFailedException, PermissionDeniedException
Journals.
In plenary mode, the returned list
contains all known journals or an error results. Otherwise, the
returned list may contain only those journals that are accessible
through this session. Journals
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.