Interface | osid.profile.rules.ProfileEntryEnablerSmartProfileSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic profiles. A This | ||
Method | getProfileId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Profile Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfile | ||
Description |
Gets the | ||
Return | osid.profile.Profile | the profile | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartProfiles | ||
Description |
Tests if this user can manage smart profiles. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart profile management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablerQuery | ||
Description |
Gets a profile entry enabler query. | ||
Return | osid.profile.rules.ProfileEntryEnablerQuery | the profile entry enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablerSearchOrder | ||
Description |
Gets a profile entry enabler search order. | ||
Return | osid.profile.rules.ProfileEntryEnablerSearchOrder | the profile entry enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyProfileEntryEnablerQuery | ||
Description |
Applies a profile entry enabler query to this profile. | ||
Parameters | osid.profile.rules.ProfileEntryEnablerQuery | profileEntryEnablerQuery | the profile entry enabler query |
Errors | NULL_ARGUMENT | profileEntryEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | profileEntryEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectProfileEntryEnablerQuery | ||
Description |
Gets a profile entry enabler query inspector for this profile. | ||
Return | osid.profile.rules.ProfileEntryEnablerQueryInspector | the profile entry enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyProfileEntryEnablerSequencing | ||
Description |
Applies a profile entry enabler search order to this profile. | ||
Parameters | osid.profile.rules.ProfileEntryEnablerSearchOrder | profileEntryEnablerSearchOrder | the profile entry enabler search order |
Errors | NULL_ARGUMENT | profileEntryEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | profileEntryEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablerQueryFromInspector | ||
Description |
Gets a profile entry enabler query from an inspector. | ||
Parameters | osid.profile.rules.ProfileEntryEnablerQueryInspector | profileEntryEnablerQueryInspector | a profile entry enabler query inspector |
Return | osid.profile.rules.ProfileEntryEnablerQuery | the profile entry enabler query | |
Errors | NULL_ARGUMENT | profileEntryEnablerQueryInspector is null | |
UNSUPPORTED | profileEntryEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |