public interface BranchQuerySession extends OsidSession
This session provides methods for searching among Branch
objects. The search query is constructed using the BranchQuery.
This session defines views that offer differing behaviors for searching.
Branches may have a query record indicated by their respective record
types. The query record is accessed via the BranchQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchBranches()
Tests if this user can perform
Branch searches. |
BranchList |
getBranchesByQuery(BranchQuery branchQuery)
Gets a list of
Branches matching the given branch
query. |
BranchQuery |
getBranchQuery()
Gets a branch query.
|
Journal |
getJournal()
Gets the
Journal associated with this session. |
Id |
getJournalId()
Gets the
Journal Id associated with this
session. |
void |
useFederatedJournalView()
Federates the view for methods in this session.
|
void |
useIsolatedJournalView()
Isolates the view for methods in this session.
|
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 canSearchBranches()
Branch
searches. 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 search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedJournalView()
mandatory
- This method is must be implemented. void useIsolatedJournalView()
mandatory
- This method is must be implemented. BranchQuery getBranchQuery()
mandatory
- This method must be implemented. BranchList getBranchesByQuery(BranchQuery branchQuery) throws OperationFailedException, PermissionDeniedException
Branches
matching the given branch
query.branchQuery
- the branch query BranchList
NullArgumentException
- branchQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- branchQuery
is
not of this servicemandatory
- This method must be implemented.