Interface | osid.profile.batch.ProfileEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.profile.ProfileEntryAdminSession | ||
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 | getProfileEntryFormsForCreateForAgents | ||
Description |
Gets the profile entry forms for creating a bunch of new profile entries. A form is returned for each agent and profile item pair. | ||
Parameters | osid.profile.batch.ProfileEntryAgentPeerList | peers | the relationship peers |
osid.type.Type[] | profileEntryRecordTypes | array of profile entry record types to be included in each create operation or an empty list if none | |
Return | osid.profile.batch.ProfileEntryBatchFormList | the profile entry forms | |
Errors | NOT_FOUND | an agentId or profileItemId is not found | |
NULL_ARGUMENT | peers or profileEntryRecordTypes 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 | getProfileEntryFormsForCreateForResources | ||
Description |
Gets the profile entry forms for creating a bunch of new profile entries. A form is returned for each resource and profile item pair. | ||
Parameters | osid.profile.batch.ProfileEntryResourcePeerList | peers | the relationship peers |
osid.type.Type[] | profileEntryRecordTypes | array of profile entry record types to be included in each create operation or an empty list if none | |
Return | osid.profile.batch.ProfileEntryBatchFormList | the profile entry forms | |
Errors | NOT_FOUND | a resourceId or profileItemId is not found | |
NULL_ARGUMENT | peers or profileEntryRecordTypes 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 | createProfileEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.profile.batch.ProfileEntryBatchFormList | profileEntryForms | the profile entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | profileEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProfileEntryFormsForUpdate | ||
Description |
Gets the profile entry forms for updating an existing set of profile entries. A new profile entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | profileEntryIds | the Ids of the ProfileEntry |
Return | osid.profile.batch.ProfileEntryBatchFormList | the profile entry form | |
Errors | NOT_FOUND | a profileEntryId is not found | |
NULL_ARGUMENT | profileEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProfileEntries | ||
Description |
Updates existing profile entries. 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.ProfileEntryBatchFormList | profileEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | profileEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllProfileEntries | ||
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 | deleteProfileEntries | ||
Description |
Deletes profile entries for the given | ||
Parameters | osid.id.IdList | profileEntryIds | the Ids of the profile entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | profileEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProfileEntriesForProfileItem | ||
Description |
Deletes profile entries for the given profile item. | ||
Parameters | osid.id.Id | profileItemId | the Id of a profile item |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | profileItemId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProfileEntriesForResource | ||
Description |
Deletes profile entries for the given resource. | ||
Parameters | osid.id.Id | resourceId | the Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveProfileEntriesByDate | ||
Description |
Deletes profile entries expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasProfileEntries | ||
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. |