Interface | osid.profile.rules.ProfileEntryEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
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 | canLookupProfileEntryEnablerRules | ||
Description |
Tests if this user can perform lookups of profile entry
enabler/profile entry mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeProfileEntryEnablerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryProfileEntryEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedProfileView | ||
Description |
Federates the view for methods in this session. A federated view will include profile entry enablers in profiles which are children of this profile in the profile hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedProfileView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this profile only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProfileEntryEnablerIdsForProfileEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileEntryId | Id of the ProfileEntry |
Return | osid.id.IdList | the profile entry enabler Ids | |
Errors | NOT_FOUND | profileEntryId is not found | |
NULL_ARGUMENT | profileEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryEnablersForProfileEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileEntryId | Id of the ProfileEntry |
Return | osid.profile.rules.ProfileEntryEnablerList | the profile entry enablers | |
Errors | NOT_FOUND | profileEntryId is not found | |
NULL_ARGUMENT | profileEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryIdsForProfileEntryEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileEntryEnablerId | Id of a ProfileEntryEnabler |
Return | osid.id.IdList | list of profile entry Ids | |
Errors | NOT_FOUND | profileEntryEnablerId is not found | |
NULL_ARGUMENT | profileEntryEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntriesForProfileEntryEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileEntryEnablerId | Id of a ProfileEntryEnabler |
Return | osid.profile.ProfileEntryList | list of profile entries | |
Errors | NOT_FOUND | profileEntryEnablerId is not found | |
NULL_ARGUMENT | profileEntryEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |