OSID - osid.logging.LogEntryAdminSession Service Interface Definition

Interface	osid.logging.LogEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.logging.batch.LogEntryBatchAdminSession`
Used By	`osid.logging.LoggingManager`
Used By	`osid.logging.LoggingProxyManager`
Description	This session creates, updates, and deletes `LogEntries`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `LogEntry`, a `LogEntryForm` is requested using `getLogEntryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `LogEntryForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `LogEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `LogEntryForm` corresponds to an attempted transaction. For updates, `LogEntryForms` are requested to the `LogEntry` `Id` that is to be updated using `getLogEntryFormForUpdate()`. Similarly, the `LogEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `LogEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `LogEntries`. To unmap a `LogEntry` from the current `Log`, the `LogEntryLogAssignmentSession` should be used. These delete operations attempt to remove the `LogEntry` itself thus removing it from all known `Log` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getLogId
Description	Gets the `Log` `Id` associated with this session.
Return	`osid.id.Id`		the `Log Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getLog
Description	Gets the `Log` associated with this session.
Return	`osid.logging.Log`		the `Log` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateLogEntries
Description	Tests if this user can create log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `LogEntry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `LogEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateLogEntryWithRecordTypes
Description	Tests if this user can create a single `LogEntry` using the desired record types. While `LoggingManager.getLogEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `LogEntry`. Providing an empty array tests if a `LogEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`logEntryRecordTypes`	array of log entry record types
Return	`boolean`		`true` if `LogEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`logEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryFormForCreate
Description	Gets the log entry form for creating new log entries. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`logEntryRecordTypes`	array of log entry record types
Return	`osid.logging.LogEntryForm`		the log entry form
Errors	NULL_ARGUMENT		`logEntryRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createLogEntry
Description	Creates a new `LogEntry`.
Parameters	`osid.logging.LogEntryForm`	`logEntryForm`	the form for this `LogEntry`
Return	`osid.logging.LogEntry`		the new `LogEntry`
Errors	ILLEGAL_STATE		`logEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`logEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`logEntryForm` did not originate from `getLogEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateLogEntries
Description	Tests if this user can update log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Log` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `LogEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryFormForUpdate
Description	Gets the log entry form for updating an existing log. A new log entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`logEntryId`	the `Id` of the `LogEntry`
Return	`osid.logging.LogEntryForm`		the log entry form
Errors	NOT_FOUND		`logEntryId` is not found
	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateLogEntry
Description	Updates an existing log entry.
Parameters	`osid.logging.LogEntryForm`	`logEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`logEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`logEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`logEntryForm` did not originate from `getLogEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteLogEntries
Description	Tests if this user can delete log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `LogEntry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `LogEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteLogEntry
Description	Deletes a `LogEntry`.
Parameters	`osid.id.Id`	`logEntryId`	the `Id` of the `logEntryId` to remove
Errors	NOT_FOUND		`logEntryId` not found
	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageLogEntryAliases
Description	Tests if this user can manage `Id` aliases for log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `LogEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasLogEntry
Description	Adds an `Id` to a `LogEntry` for the purpose of creating compatibility. The primary `Id` of the `LogEntry` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another log entry, it is reassigned to the given log entry `Id`.
Parameters	`osid.id.Id`	`logEntryId`	the `Id` of a `LogEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`logEntryId` not found
	NULL_ARGUMENT		`logEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.