Interface | osid.profile.ProfileItemProfileAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignProfileItems | ||
Description |
Tests if this user can alter profile/item 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 | canAssignProfileItemsToProfile | ||
Description |
Tests if this user can alter profile/item 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 profile including and under the given profile node in which any profile item 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 | getAssignableProfileIdsForProfileItem | ||
Description |
Gets a list of profile including and under the given profile node in which a specific profile item can be assigned. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
osid.id.Id | profileItemId | the Id of the ProfileItem | |
Return | osid.id.IdList | list of assignable profile Ids | |
Errors | NULL_ARGUMENT | profileId or profileItemId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignProfileItemToProfile | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | profileItemId | the Id of the ProfileItem |
osid.id.Id | profileId | the Id of the Profile | |
Errors | ALREADY_EXISTS | profileItemId is already assigned to profileId
| |
NOT_FOUND | profileItemId or profileId not found | ||
NULL_ARGUMENT | profileItemId or profileId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignProfileItemFromProfile | ||
Description |
Removes a | ||
Parameters | osid.id.Id | profileItemId | the Id of the ProfileItem |
osid.id.Id | profileId | the Id of the Profile | |
Errors | NOT_FOUND | profileItemId or profileId not found or
profileItemId not assigned to profileId | |
NULL_ARGUMENT | profileItemId or profileId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignProfileItemToProfile | ||
Description |
Moves a | ||
Parameters | osid.id.Id | profileItemId | the Id of the ProfileItem |
osid.id.Id | fromProfileId | the Id of the current Profile | |
osid.id.Id | toProfileId | the Id of the destination Profile | |
Errors | NOT_FOUND | profileItemId, fromProfileId, or toProfileId
not found or profileItemId not mapped to fromProfileId
| |
NULL_ARGUMENT | profileItemId, fromProfileId, or toProfileId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |