public interface AvailabilityEnablerQuerySession extends OsidSession
This session provides methods for searching among
AvailabilityEnabler
objects. The search query is constructed using
the AvailabilityEnablerQuery.
This session defines views that offer differing behaviors for searching.
An availability enabler may have an availability enabler query record
indicated by their respective record types. The availability enabler query
record is accessed via the AvailabilityEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAvailabilityEnablers()
Tests if this user can perform
AvailabilityEnabler
lookups. |
AvailabilityEnablerQuery |
getAvailabilityEnablerQuery()
Gets an availability enabler query.
|
AvailabilityEnablerList |
getAvailabilityEnablersByQuery(AvailabilityEnablerQuery availabilityEnablerQuery)
Gets a list of
AvailabilityEnablers matching the given
availability enabler query. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAvailabilityEnablers()
AvailabilityEnabler
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 search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. AvailabilityEnablerQuery getAvailabilityEnablerQuery()
mandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersByQuery(AvailabilityEnablerQuery availabilityEnablerQuery) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablers
matching the given
availability enabler query.availabilityEnablerQuery
- the availability enabler query AvailabilityEnablerList
NullArgumentException
- availabilityEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- availabilityEnablerQuery
is not of this servicemandatory
- This method must be implemented.