| Interface | osid.logging.LogEntryLogAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign log entries to
Moving or adding a reference of a | ||
| Method | canAssignLogEntries | ||
| Description |
Tests if this user can alter log entry/log mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignLogEntriesToLog | ||
| Description |
Tests if this user can alter log entry/log mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Parameters | osid.id.Id | logId | the Id of the Log |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | logId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableLogIds | ||
| Description |
Gets a list of log including and under the given log node in which any log entry can be assigned. | ||
| Parameters | osid.id.Id | logId | the Id of the Log |
| Return | osid.id.IdList | list of assignable log Ids | |
| Errors | NULL_ARGUMENT | logId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableLogIdsForLogEntry | ||
| Description |
Gets a list of log including and under the given log node in which a specific log entry can be assigned. | ||
| Parameters | osid.id.Id | logId | the Id of the Log |
osid.id.Id | logEntryId | the Id of the LogEntry | |
| Return | osid.id.IdList | list of assignable log Ids | |
| Errors | NULL_ARGUMENT | logId or logEntryId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignLogEntryToLog | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | logEntryId | the Id of the LogEntry |
osid.id.Id | logId | the Id of the Log | |
| Errors | ALREADY_EXISTS | logEntryId is already assigned to logId | |
| NOT_FOUND | logEntryId or logId not found | ||
| NULL_ARGUMENT | logEntryId or logId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignLogEntryFromLog | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | logEntryId | the Id of the LogEntry |
osid.id.Id | logId | the Id of the Log | |
| Errors | NOT_FOUND | logEntryId or logId not found or
logEntryId not assigned to logId | |
| NULL_ARGUMENT | logEntryId or logId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignLogEntryToLog | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | logEntryId | the Id of the LogEntry |
osid.id.Id | fromLogId | the Id of the current Log | |
osid.id.Id | toLogId | the Id of the destination Log | |
| Errors | NOT_FOUND | logEntryId, fromLogId, or toLogId not found
or logEntryId not mapped to fromLogId | |
| NULL_ARGUMENT | logEntryId, fromLogId, or toLogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |