Interface | osid.profile.rules.ProfileRulesManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.profile.rules.ProfileRulesProfile | |||
Description |
The profile rules manager provides access to profile rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getProfileEntryEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerLookupSession | a ProfileEntryEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerLookup() is true. | |
Method | getProfileEntryEnablerLookupSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerLookupSession | a ProfileEntryEnablerLookupSession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerLookup() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerQuerySession | a ProfileEntryEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerQuery() is true. | |
Method | getProfileEntryEnablerQuerySessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerQuerySession | a ProfileEntryEnablerQuerySession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerQuery() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerSearchSession | a ProfileEntryEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerSearch() is true. | |
Method | getProfileEntryEnablerSearchSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerSearchSession | a ProfileEntryEnablerSearchSession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerSearch() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerAdminSession | a ProfileEntryEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerAdmin() is true. | |
Method | getProfileEntryEnablerAdminSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerAdminSession | a ProfileEntryEnablerAdminSession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerAdmin() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.profile.rules.ProfileEntryEnablerReceiver | profileEntryEnablerReceiver | the notification callback |
Return | osid.profile.rules.ProfileEntryEnablerNotificationSession | a ProfileEntryEnablerNotificationSession | |
Errors | NULL_ARGUMENT | profileEntryEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerNotification() is true. | |
Method | getProfileEntryEnablerNotificationSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.profile.rules.ProfileEntryEnablerReceiver | profileEntryEnablerReceiver | the notification callback |
osid.id.Id | profileId | the Id of the Profile | |
Return | osid.profile.rules.ProfileEntryEnablerNotificationSession | a ProfileEntryEnablerNotificationSession | |
Errors | NOT_FOUND | no profile found by the given Id | |
NULL_ARGUMENT | profileEntryEnablerReceiver or profileId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryEnablerProfileSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerProfileSession | a ProfileEntryEnablerProfileSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerProfile() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerProfile() is true. | |
Method | getProfileEntryEnablerProfileAssignmentSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerProfileAssignmentSession | a ProfileEntryEnablerProfileAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerProfileAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerProfileAssignment() is true. | |
Method | getProfileEntryEnablerSmartProfileSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerSmartProfileSession | a ProfileEntryEnablerSmartProfileSession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerSmartProfile() is false
| ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerSmartProfile() is true. | |
Method | getProfileEntryEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerRuleLookupSession | a ProfileEntryEnablerRuleSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerRuleLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerRuleLookup() is true. | |
Method | getProfileEntryEnablerRuleLookupSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerRuleLookupSession | a ProfileEntryEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getProfileEntryEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.profile.rules.ProfileEntryEnablerRuleApplicationSession | a ProfileEntryEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProfileEntryEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerRuleApplication() is true. | |
Method | getProfileEntryEnablerRuleApplicationSessionForProfile | ||
Description |
Gets the | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.rules.ProfileEntryEnablerRuleApplicationSession | a ProfileEntryEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Profile found by the given Id | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProfileEntryEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProfileEntryEnablerRuleApplication() and
supportsVisibleFederation() are true. |