public interface ProfileEntryEnablerQuerySession extends OsidSession
This session provides methods for searching among
ProfileEntryEnabler
objects. The search query is constructed using
the ProfileEntryEnablerQuery.
This session defines views that offer differing behaviors for searching.
Profile entry enablers may have a profile entry enabler query record
indicated by their respective record types. The profile entry enabler
query record is accessed via the ProfileEntryEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchProfileEntryEnablers()
Tests if this user can perform
ProfileEntryEnabler
lookups. |
Profile |
getProfile()
Gets the
Profile associated with this session. |
ProfileEntryEnablerQuery |
getProfileEntryEnablerQuery()
Gets a profile entry enabler query.
|
ProfileEntryEnablerList |
getProfileEntryEnablersByQuery(ProfileEntryEnablerQuery profileEntryEnablerQuery)
Gets a list of
ProfileEntryEnablers matching the given
profile entry enabler query. |
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
void |
useFederatedProfileView()
Federates the view for methods in this session.
|
void |
useIsolatedProfileView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProfileId()
Profile
Id
associated with this
session. Profile Id
associated with this sessionmandatory
- This method must be implemented. Profile getProfile() throws OperationFailedException, PermissionDeniedException
Profile
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchProfileEntryEnablers()
ProfileEntryEnabler
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 useFederatedProfileView()
mandatory
- This method is must be implemented. void useIsolatedProfileView()
mandatory
- This method is must be implemented. ProfileEntryEnablerQuery getProfileEntryEnablerQuery()
mandatory
- This method must be implemented. ProfileEntryEnablerList getProfileEntryEnablersByQuery(ProfileEntryEnablerQuery profileEntryEnablerQuery) throws OperationFailedException, PermissionDeniedException
ProfileEntryEnablers
matching the given
profile entry enabler query.profileEntryEnablerQuery
- the profile entry enabler query ProfileEntryEnablerList
NullArgumentException
- profileEntryEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- profileEntryEnablerQuery
is not of this servicemandatory
- This method must be implemented.