public interface JournalEntryLookupSession extends OsidSession
This session defines methods for retrieving journal entries. A
JournalEntry
is a version entry for an OSID Id.
This lookup session defines several views:
JournalEntryAdminSession.
The methods useFederatedJournalView()
and
useIsolatedJournalView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canReadJournal()
Tests if this user can examine this journal.
|
Journal |
getJournal()
Gets the
Journal associated with this session. |
JournalEntryList |
getJournalEntries()
Gets all journal entries.
|
JournalEntryList |
getJournalEntriesByDateForBranch(Id branchId,
DateTime date)
Gets the journal entry corresponding to a resource
Id
and date. |
JournalEntryList |
getJournalEntriesByDateForBranchAndSource(Id branchId,
Id sourceId,
DateTime date)
Gets the journal entry corresponding to a branch and source
Id
and date. |
JournalEntryList |
getJournalEntriesByDateForResource(Id resourceId,
DateTime date)
Gets the journal entry corresponding to a resource
Id
and date. |
JournalEntryList |
getJournalEntriesByDateForSource(Id sourceId,
DateTime date)
Gets the journal entry corresponding to a source
Id and
date. |
JournalEntryList |
getJournalEntriesByDateRangeForBranch(Id branchId,
DateTime from,
DateTime to)
Gets a list of journal entries corresponding to a branch
Id
and date range. |
JournalEntryList |
getJournalEntriesByDateRangeForBranchAndSource(Id branchId,
Id sourceId,
DateTime from,
DateTime to)
Gets a list of journal entries corresponding to a branch and source
Id and date range. |
JournalEntryList |
getJournalEntriesByDateRangeForResource(Id resourceId,
DateTime from,
DateTime to)
Gets a list of journal entries corresponding to a resource
Id
and date range. |
JournalEntryList |
getJournalEntriesByDateRangeForSource(Id sourceId,
DateTime from,
DateTime to)
Gets a list of journal entries corresponding to a source
Id
and date range. |
JournalEntryList |
getJournalEntriesByGenusType(Type journalEntryGenusType)
Gets a
JournalEntryList corresponding to the given
journal entry genus Type which does not include journal
entries of genus types derived from the specified Type. |
JournalEntryList |
getJournalEntriesByIds(IdList journalEntryIds)
Gets a
JournalEntryList corresponding to the given
IdList. |
JournalEntryList |
getJournalEntriesByParentGenusType(Type journalEntryGenusType)
Gets a
JournalEntryList corresponding to the given
journal entry genus Type and include any additional
journal entries with genus types derived from the specified
Type. |
JournalEntryList |
getJournalEntriesByRecordType(Type journalEntryRecordType)
Gets a
JournalEntryList containing the given journal
entry record Type. |
JournalEntryList |
getJournalEntriesForBranch(Id branchId)
Gets a list of journal entries corresponding to a branch
Id. |
JournalEntryList |
getJournalEntriesForBranchAndSource(Id branchId,
Id sourceId)
Gets a list of journal entries corresponding to a branch and source
Id. |
JournalEntryList |
getJournalEntriesForResource(Id resourceId)
Gets a list of journal entries corresponding to a resource
Id. |
JournalEntryList |
getJournalEntriesForSource(Id sourceId)
Gets a list of journal entries corresponding to a source
Id. |
JournalEntry |
getJournalEntry(Id journalEntryId)
Gets the
JournalEntry specified by its Id. |
Id |
getJournalId()
Gets the
Journal Id associated with this
session. |
void |
useComparativeJournalEntryView()
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 |
useFederatedJournalView()
Federates the view for methods in this session.
|
void |
useIsolatedJournalView()
Isolates the view for methods in this session.
|
void |
usePlenaryJournalEntryView()
A complete view of the
JournalEntry returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getJournalId()
Journal
Id
associated with this
session. Journal Id
associated with this sessionmandatory
- This method must be implemented. Journal getJournal() throws OperationFailedException, PermissionDeniedException
Journal
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canReadJournal()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if journal reading methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeJournalEntryView()
mandatory
- This method is must be implemented. void usePlenaryJournalEntryView()
JournalEntry
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. void useFederatedJournalView()
mandatory
- This method is must be implemented. void useIsolatedJournalView()
mandatory
- This method is must be implemented. JournalEntry getJournalEntry(Id journalEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JournalEntry
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
JournalEntry
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a JournalEntry
and retained for
compatibility.journalEntryId
- the Id
of the
JournalEntry
to retrieve JournalEntry
NotFoundException
- no JournalEntry
found with the given Id
NullArgumentException
- journalEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByIds(IdList journalEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
JournalEntryList
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.journalEntryIds
- the list of Ids
to retrieve JournalEntry list
NotFoundException
- an Id was
not foundNullArgumentException
- journalEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByGenusType(Type journalEntryGenusType) throws OperationFailedException, PermissionDeniedException
JournalEntryList
corresponding to the given
journal entry genus Type
which does not include journal
entries of genus types derived from the specified Type.
In plenary mode, the returned list contains all known journal entries
or an error results. Otherwise, the returned list may contain only
those journal entries that are accessible through this session.journalEntryGenusType
- a journal entry genus type JournalEntry
listNullArgumentException
- journalEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByParentGenusType(Type journalEntryGenusType) throws OperationFailedException, PermissionDeniedException
JournalEntryList
corresponding to the given
journal entry genus Type
and include any additional
journal entries with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
journal entries or an error results. Otherwise, the returned list may
contain only those journal entries that are accessible through this
session.journalEntryGenusType
- a journal entry genus type JournalEntry
listNullArgumentException
- journalEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByRecordType(Type journalEntryRecordType) throws OperationFailedException, PermissionDeniedException
JournalEntryList
containing the given journal
entry record Type.
In plenary mode, the returned list
contains all known journal entries or an error results. Otherwise, the
returned list may contain only those journal entries that are
accessible through this session.journalEntryRecordType
- a journal entry record type JournalEntry
listNullArgumentException
- journalEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesForBranch(Id branchId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known journal
entries or an error results. Otherwise, the returned list may contain
only those journal entries that are accessible through this session.branchId
- the Id
of the branch JournalEntryList
NullArgumentException
- branchId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateForBranch(Id branchId, DateTime date) throws OperationFailedException, PermissionDeniedException
Id
and date. The entries returned have a date equal to or more recent
than the requested date. In plenary mode, the returned list contains
all known journal entries or an error results. Otherwise, the returned
list may contain only those journal entries that are accessible
through this session.branchId
- the Id
of the branchdate
- from date JournalEntryList
NullArgumentException
- branchId
or
date
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateRangeForBranch(Id branchId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and date range. Entries are returned with dates that fall
between the requested dates inclusive. In plenary mode, the returned
list contains all known journal entries or an error results.
Otherwise, the returned list may contain only those journal entries
that are accessible through this session.branchId
- the Id
of the branchfrom
- from dateto
- to date JournalEntryList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- branchId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
Id.
A source Id
of any version may be requested. In
plenary mode, the returned list contains all known journal entries or
an error results. Otherwise, the returned list may contain only those
journal entries that are accessible through this session.sourceId
- the Id
of the source JournalEntryList
NullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateForSource(Id sourceId, DateTime date) throws OperationFailedException, PermissionDeniedException
Id
and
date. The entry returned has a date equal to or more recent than the
requested date. The sourceId
may correspond to any
version. In plenary mode, the returned list contains all known journal
entries or an error results. Otherwise, the returned list may contain
only those journal entries that are accessible through this session.sourceId
- a source Id
date
- from date JournalEntryList
NullArgumentException
- sourceId
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateRangeForSource(Id sourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and date range. Entries are returned with dates that fall
between the requested dates inclusive. The sourceId
may
correspond to any version. In plenary mode, the returned list contains
all known journal entries or an error results. Otherwise, the returned
list may contain only those journal entries that are accessible
through this session.sourceId
- a source Id
from
- from dateto
- to date JournalEntryList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- sourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesForBranchAndSource(Id branchId, Id sourceId) throws OperationFailedException, PermissionDeniedException
Id.
A source Id
of any version may be
requested.
In plenary mode, the returned list contains
all known journal entries or an error results. Otherwise, the returned
list may contain only those journal entries that are accessible
through this session.branchId
- the Id
of the branchsourceId
- the Id
of the source JournalEntryList
NullArgumentException
- branchId
or
sourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateForBranchAndSource(Id branchId, Id sourceId, DateTime date) throws OperationFailedException, PermissionDeniedException
Id
and date. The entry returned has a date equal to or more
recent than the requested date. The sourceId
may
correspond to any version. In plenary mode, the returned list contains
all known journal entries or an error results. Otherwise, the returned
list may contain only those journal entries that are accessible
through this session.branchId
- a branch Id
sourceId
- the Id
of the sourcedate
- from date JournalEntryList
NullArgumentException
- branchId, sourceId
or date
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateRangeForBranchAndSource(Id branchId, Id sourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and date range. Entries are returned with dates that
fall between the requested dates inclusive. The sourceId
may correspond to any version In plenary mode, the returned
list contains all known journal entries or an error results.
Otherwise, the returned list may contain only those journal entries
that are accessible through this session.branchId
- a branch Id
sourceId
- the Id
of the sourcefrom
- from dateto
- to date JournalEntryList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- branchId, sourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known journal
entries or an error results. Otherwise, the returned list may contain
only those journal entries that are accessible through this session.resourceId
- the Id
of the resource JournalEntryList
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateForResource(Id resourceId, DateTime date) throws OperationFailedException, PermissionDeniedException
Id
and date. The entry returned has a date equal to or more recent than
the requested date. In plenary mode, the returned list contains all
known journal entries or an error results. Otherwise, the returned
list may contain only those journal entries that are accessible
through this session.resourceId
- the Id
of the resourcedate
- from date JournalEntryList
NullArgumentException
- resourceId
or
date
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntriesByDateRangeForResource(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and date range. Entries are returned with dates that fall
between the requested dates inclusive. In plenary mode, the returned
list contains all known journal entries or an error results.
Otherwise, the returned list may contain only those journal entries
that are accessible through this session.resourceId
- the Id
of the resourcefrom
- from dateto
- to date JournalEntryList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalEntryList getJournalEntries() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.