Interface | osid.profile.rules.ProfileEntryEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
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 | canAssignProfileEntryEnablers | ||
Description |
Tests if this user can alter profile entry
enabler/profile entry mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known mapping methods in this session
will result in a | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignProfileEntryEnablerToProfileEntry | ||
Description |
Tests if this user can alter profile entry
enabler/profile entry mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known mapping methods in this session
will result in a | ||
Parameters | osid.id.Id | profileEntryId | the Id of the ProfileEntry |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | profileEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableProfileEntryIdsForProfileEntryEnabler | ||
Description |
Gets a list of profile entry in which a specific profile entry enabler can be assigned. | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler |
Return | osid.id.IdList | list of assignable profile entry Ids | |
Errors | NULL_ARGUMENT | profileEntryEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignProfileEntryEnablerToProfileEntry | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler |
osid.id.Id | profileEntryId | the Id of the ProfileEntry | |
Errors | ALREADY_EXISTS | profileEntryEnablerId is already applied to
profileEntryId | |
NOT_FOUND | profileEntryEnablerId or profileEntryId not
found | ||
NULL_ARGUMENT | profileEntryEnablerId or profileEntryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignProfileEntryEnablerFromProfileEntry | ||
Description |
Removes a | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler |
osid.id.Id | profileEntryId | the Id of the ProfileEntry | |
Errors | NOT_FOUND | profileEntryEnablerId or profileEntryId not
found or profileEntryEnablerId not applied to profileEntryId | |
NULL_ARGUMENT | profileEntryEnablerId or profileEntryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceProfileEntryEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if ProfileEntryEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveProfileEntryEnablerAhead | ||
Description |
Reorders profile entry enablers for a profile entry by moving the specified profile entry enabler in front of a reference profile entry enabler. | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of a ProfileEntryEnabler |
osid.id.Id | profileEntryId | the Id of a ProfileEntry | |
osid.id.Id | referenceId | the reference profile entry enabler Id | |
Errors | NOT_FOUND | profileEntryEnablerId, profileEntryId, or referenceId
not found or, profileEntryEnablerId or
referenceId not related to profileEntryId | |
NULL_ARGUMENT | profileEntryEnablerId, profileEntryId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveProfileEntryEnablerBehind | ||
Description |
Reorders profile entry enablers for a profile entry by moving the specified profile entry enabler behind a reference profile entry enabler. | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of a ProfileEntryEnabler |
osid.id.Id | profileEntryId | the Id of a ProfileEntry | |
osid.id.Id | referenceId | the reference profile entry enabler Id | |
Errors | NOT_FOUND | profileEntryEnablerId, profileEntryId, or referenceId
not found or, profileEntryEnablerId or
referenceId not related to profileEntryId | |
NULL_ARGUMENT | profileEntryEnablerId, profileEntryId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderProfileEntryEnablers | ||
Description |
Reorders a set of profile entry enablers for a profile entry. | ||
Parameters | osid.id.Id[] | profileEntryEnablerIds | the Ids for a set of ProfileEntryEnablers |
osid.id.Id | profileEntryId | the Id of a ProfileEntry | |
Errors | NOT_FOUND | profileEntryId not found or, an profileEntryEnablerId
not related to profileEntryId | |
NULL_ARGUMENT | profileEntryEnablerIds or profileEntryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |