public interface BranchSmartJournalSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A BranchQuery
can be retrieved from this session
and mapped to this Journal
to create a virtual collection
of Branches.
The branches may be sequenced using the
BranchSearchOrder
from this session.
This Journal
has a default query that matches any
branch and a default search order that specifies no sequencing. The
queries may be examined using a BranchQueryInspector.
The
query may be modified by converting the inspector back to a
BranchQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBranchQuery(BranchQuery branchQuery)
Applies a branch query to this journal.
|
void |
applyBranchSequencing(BranchSearchOrder branchSearchOrder)
Applies a branch search order to this journal.
|
boolean |
canManageSmartJournals()
Tests if this user can manage smart journals.
|
BranchQuery |
getBranchQuery()
Gets a branch query.
|
BranchQuery |
getBranchQueryFromInspector(BranchQueryInspector branchQueryInspector)
Gets a branch query from an inspector.
|
BranchSearchOrder |
getBranchSearchOrder()
Gets a branch search order.
|
Journal |
getJournal()
Gets the
Journal associated with this session. |
Id |
getJournalId()
Gets the
Journal Id associated with this
session. |
BranchQueryInspector |
inspectBranchQuery()
Gets a branch query inspector for this journal.
|
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. Journal
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartJournals()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart journal management is not
authorized, true
otherwisemandatory
- This method must be implemented. BranchQuery getBranchQuery()
mandatory
- This method must be implemented. BranchSearchOrder getBranchSearchOrder()
mandatory
- This method must be implemented. void applyBranchQuery(BranchQuery branchQuery) throws OperationFailedException, PermissionDeniedException
branchQuery
- the branch queryNullArgumentException
- branchQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- branchQuery
not
of this servicemandatory
- This method must be implemented. BranchQueryInspector inspectBranchQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBranchSequencing(BranchSearchOrder branchSearchOrder) throws OperationFailedException, PermissionDeniedException
branchSearchOrder
- the branch search orderNullArgumentException
- branchSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- branchSearchOrder
not of this servicemandatory
- This method must be implemented. BranchQuery getBranchQueryFromInspector(BranchQueryInspector branchQueryInspector)
branchQueryInspector
- a branch query inspectorNullArgumentException
- branchQueryInspector
is null
UnsupportedException
- branchQueryInspector
is not of this servicemandatory
- This method must be implemented.