Interface | osid.profile.ProfileAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateProfiles | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Profile creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProfileWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | profileRecordTypes | array of profile recod types |
Return | boolean | true if Profile creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | profileRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileFormForCreate | ||
Description |
Gets the profile form for creating new profiles. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | profileRecordTypes | array of profile recod types |
Return | osid.profile.ProfileForm | the profile form | |
Errors | NULL_ARGUMENT | profileRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createProfile | ||
Description |
Creates a new | ||
Parameters | osid.profile.ProfileForm | profileForm | the form for this Profile |
Return | osid.profile.Profile | the new Profile | |
Errors | ILLEGAL_STATE | profileForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | profileForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileForm did not originate from
getProfileFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProfiles | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Profile modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProfileFormForUpdate | ||
Description |
Gets the profile form for updating an existing profile. A new profile form should be requested for each update transaction. | ||
Parameters | osid.id.Id | profileId | the Id of the Profile |
Return | osid.profile.ProfileForm | the profile form | |
Errors | NOT_FOUND | profileId is not found | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProfile | ||
Description |
Updates an existing profile. | ||
Parameters | osid.profile.ProfileForm | profileForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | profileForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | profileForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | profileForm did not originate from
getProfileFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProfiles | ||
Description |
Tests if this user can delete profiles. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting a | ||
Return | boolean | false if Profile deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteProfile | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | profileId | the Id of the Profile to remove |
Errors | NOT_FOUND | profileId not found | |
NULL_ARGUMENT | profileId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProfileAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Profile aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProfile | ||
Description |
Adds an | ||
Parameters | osid.id.Id | profileId | the Id of a Profile |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | profileId not found | ||
NULL_ARGUMENT | profileId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |