Interface | osid.logging.batch.LogEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.logging.LogEntryAdminSession | ||
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 | getLogEntryFormsForCreate | ||
Description |
Gets the log entry forms for creating a bunch of new log entries. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | logEntryRecordTypes | array of log entry record types to be included in each create operation or an empty list if none | |
Return | osid.logging.batch.LogEntryBatchFormList | the log entry forms | |
Errors | NULL_ARGUMENT | logEntryRecordTypes 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 | createLogEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.logging.batch.LogEntryBatchFormList | logEntryForms | the log entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | logEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntryFormsForUpdate | ||
Description |
Gets the log entry forms for updating an existing set of log entries. A new log entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | logEntryIds | the Ids of the LogEntry |
Return | osid.logging.batch.LogEntryBatchFormList | the log entry form | |
Errors | NOT_FOUND | a logEntryId is not found | |
NULL_ARGUMENT | logEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateLogEntries | ||
Description |
Updates existing log 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.logging.batch.LogEntryBatchFormList | logEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | logEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllLogEntries | ||
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 | deleteLogEntries | ||
Description |
Deletes log entries for the given | ||
Parameters | osid.id.IdList | logEntryIds | the Ids of the log entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | logEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteLogEntriesByResource | ||
Description |
Deletes log 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 | deleteLogEntriesByDate | ||
Description |
Deletes log entries between the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasLogEntries | ||
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. |