Interface | osid.profile.ProfileEntryProfileAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign profile entries
to Moving or adding a reference of a | ||
Method | canAssignProfileEntries | ||
Description |
Tests if this user can alter profile entry/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 | canAssignProfileEntriesToProfile | ||
Description |
Tests if this user can alter profile entry/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 profile including and under the given profile node in which any profile entry 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 | getAssignableProfileIdsForProfileEntry | ||
Description |
Gets a list of profile including and under the given profile node in which a specific profile entry can be assigned. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
osid.id.Id | profileEntryId | the Id of the ProfileEntry | |
Return | osid.id.IdList | list of assignable profile Ids | |
Errors | NULL_ARGUMENT | profileId or profileEntryId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignProfileEntryToProfile | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | profileEntryId | the Id of the ProfileEntry |
osid.id.Id | profileId | the Id of the Profile | |
Errors | ALREADY_EXISTS | profileEntryId is already assigned to profileId
| |
NOT_FOUND | profileEntryId or profileId not found | ||
NULL_ARGUMENT | profileEntryId or profileId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignProfileEntryFromProfile | ||
Description |
Removes a | ||
Parameters | osid.id.Id | profileEntryId | the Id of the ProfileEntry |
osid.id.Id | profileId | the Id of the Profile | |
Errors | NOT_FOUND | profileEntryId or profileId not found or
profileEntryId not assigned to profileId | |
NULL_ARGUMENT | profileEntryId or profileId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignProfileEntryToProfile | ||
Description |
Moves a | ||
Parameters | osid.id.Id | profileEntryId | the Id of the ProfileEntry |
osid.id.Id | fromProfileId | the Id of the current Profile | |
osid.id.Id | toProfileId | the Id of the destination Profile | |
Errors | NOT_FOUND | profileEntryId, fromProfileId, or toProfileId
not found or profileEntryId not mapped to fromProfileId
| |
NULL_ARGUMENT | profileEntryId, fromProfileId, or toProfileId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |