Interface | osid.logging.LogAdminSession | ||
---|---|---|---|
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 | canCreateLogs | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Log creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateLogWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | logRecordTypes | array of log record types |
Return | boolean | true if Log creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | logRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogFormForCreate | ||
Description |
Gets the log form for creating new logs. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | logRecordTypes | array of log record types |
Return | osid.logging.LogForm | the log form | |
Errors | NULL_ARGUMENT | logRecordTypes 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 | createLog | ||
Description |
Creates a new | ||
Parameters | osid.logging.LogForm | logForm | the form for this Log |
Return | osid.logging.Log | the new Log | |
Errors | ILLEGAL_STATE | logForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | logForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | logForm did not originate from getLogFormForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateLogs | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Log modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogFormForUpdate | ||
Description |
Gets the log form for updating an existing log. A new log form should be requested for each update transaction. | ||
Parameters | osid.id.Id | logId | the Id of the Log |
Return | osid.logging.LogForm | the log form | |
Errors | NOT_FOUND | logId is not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateLog | ||
Description |
Updates an existing log. | ||
Parameters | osid.logging.LogForm | logForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | logForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | logId or logForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | logForm did not originate from getLogFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteLogs | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Log deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteLog | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | logId | the Id of the Log to remove |
Errors | NOT_FOUND | logId not found | |
NULL_ARGUMENT | logId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageLogAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Log aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasLog | ||
Description |
Adds an | ||
Parameters | osid.id.Id | logId | the Id of a Log |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | logId not found | ||
NULL_ARGUMENT | logId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |