Interface | osid.profile.batch.ProfileItemBatchAdminSession | ||
---|---|---|---|
Implements | osid.profile.ProfileItemAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getProfileItemFormsForCreate | ||
Description |
Gets the profile item forms for creating a bunch of new profile items. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | profileItemRecordTypes | array of profile item record types to be included in each create operation or an empty list if none | |
Return | osid.profile.batch.ProfileItemBatchFormList | the profile item forms | |
Errors | NULL_ARGUMENT | profileItemRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createProfileItems | ||
Description |
Creates a new set of | ||
Parameters | osid.profile.batch.ProfileItemBatchFormList | profileItemForms | the profile item forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | profileItemForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileItemFormsForUpdate | ||
Description |
Gets the profile item forms for updating an existing set of profile items. A new profile item form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | profileItemIds | the Ids of the ProfileItem |
Return | osid.profile.batch.ProfileItemBatchFormList | the profile item form | |
Errors | NOT_FOUND | a profileItemId is not found | |
NULL_ARGUMENT | profileItemIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProfileItems | ||
Description |
Updates existing profile items. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.profile.batch.ProfileItemBatchFormList | profileItemForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | profileItemForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllProfileItems | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProfileItems | ||
Description |
Deletes profile items for the given | ||
Parameters | osid.id.IdList | profileItemIds | the Ids of the profile items to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | profileItemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasProfileItems | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |