Interface | osid.profile.rules.ProfileEntryEnablerProfileAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignProfileEntryEnablers | ||
Description |
Tests if this user can alter profile entry
enabler/profile 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 | canAssignProfileEntryEnablersToProfile | ||
Description |
Tests if this user can alter profile entry
enabler/profile 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 | profileId | the Id of the Profile |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | profileId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableProfileIds | ||
Description |
Gets a list of profiles including and under the given profile node in which any profile entry enabler can be assigned. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.id.IdList | list of assignable profile Ids | |
Errors | NULL_ARGUMENT | profileId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableProfileIdsForProfileEntryEnabler | ||
Description |
Gets a list of profiles including and under the given profile node in which a specific profile entry enabler can be assigned. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler | |
Return | osid.id.IdList | list of assignable profile Ids | |
Errors | NULL_ARGUMENT | profileId or profileEntryEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignProfileEntryEnablerToProfile | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler |
osid.id.Id | profileId | the Id of the Profile | |
Errors | ALREADY_EXISTS | profileEntryEnablerId is already assigned to
profileId | |
NOT_FOUND | profileEntryEnablerId or profileId not found | ||
NULL_ARGUMENT | profileEntryEnablerId or profileId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignProfileEntryEnablerFromProfile | ||
Description |
Removes a | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler |
osid.id.Id | profileId | the Id of the Profile | |
Errors | NOT_FOUND | profileEntryEnablerId or profileId not found
or profileEntryEnablerId not assigned to profileId
| |
NULL_ARGUMENT | profileEntryEnablerId or profileId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignProfileEntryEnablerToProfile | ||
Description |
Moves a | ||
Parameters | osid.id.Id | profileEntryEnablerId | the Id of the ProfileEntryEnabler |
osid.id.Id | fromProfileId | the Id of the current Profile | |
osid.id.Id | toProfileId | the Id of the destination Profile | |
Errors | NOT_FOUND | profileEntryEnablerId, fromProfileId, or toProfileId
not found or profileEntryEnablerId not mapped to
fromProfileId | |
NULL_ARGUMENT | profileEntryEnablerId, fromProfileId, or toProfileId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |