public interface ProfileEntryEnablerSmartProfileSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
profiles. A ProfileEntryEnablerQuery
can be retrieved from
this session and mapped to this Profile
to create a virtual
collection of profile entry enablers. The profile entry enablers may be
sequenced using the ProfileEntryEnablerSearchOrder
from
this session.
This Profile
has a default query that matches any
profile entry enabler and a default search order that specifies no
sequencing. The queries may be examined using a
ProfileEntryEnablerQueryInspector.
The query may be modified by
converting the inspector back to a ProfileEntryEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyProfileEntryEnablerQuery(ProfileEntryEnablerQuery profileEntryEnablerQuery)
Applies a profile entry enabler query to this profile.
|
void |
applyProfileEntryEnablerSequencing(ProfileEntryEnablerSearchOrder profileEntryEnablerSearchOrder)
Applies a profile entry enabler search order to this profile.
|
boolean |
canManageSmartProfiles()
Tests if this user can manage smart profiles.
|
Profile |
getProfile()
Gets the
Profile associated with this session. |
ProfileEntryEnablerQuery |
getProfileEntryEnablerQuery()
Gets a profile entry enabler query.
|
ProfileEntryEnablerQuery |
getProfileEntryEnablerQueryFromInspector(ProfileEntryEnablerQueryInspector profileEntryEnablerQueryInspector)
Gets a profile entry enabler query from an inspector.
|
ProfileEntryEnablerSearchOrder |
getProfileEntryEnablerSearchOrder()
Gets a profile entry enabler search order.
|
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
ProfileEntryEnablerQueryInspector |
inspectProfileEntryEnablerQuery()
Gets a profile entry enabler query inspector for this profile.
|
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 canManageSmartProfiles()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart profile management is not
authorized, true
otherwisemandatory
- This method must be implemented. ProfileEntryEnablerQuery getProfileEntryEnablerQuery()
mandatory
- This method must be implemented. ProfileEntryEnablerSearchOrder getProfileEntryEnablerSearchOrder()
mandatory
- This method must be implemented. void applyProfileEntryEnablerQuery(ProfileEntryEnablerQuery profileEntryEnablerQuery) throws OperationFailedException, PermissionDeniedException
profileEntryEnablerQuery
- the profile entry enabler queryNullArgumentException
- profileEntryEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- profileEntryEnablerQuery
not of this servicemandatory
- This method must be implemented. ProfileEntryEnablerQueryInspector inspectProfileEntryEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyProfileEntryEnablerSequencing(ProfileEntryEnablerSearchOrder profileEntryEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
profileEntryEnablerSearchOrder
- the profile entry enabler
search orderNullArgumentException
-
profileEntryEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
profileEntryEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. ProfileEntryEnablerQuery getProfileEntryEnablerQueryFromInspector(ProfileEntryEnablerQueryInspector profileEntryEnablerQueryInspector)
profileEntryEnablerQueryInspector
- a profile entry enabler
query inspectorNullArgumentException
-
profileEntryEnablerQueryInspector
is null
UnsupportedException
-
profileEntryEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.