OSID - osid.logging.LogAdminSession Service Interface Definition

Interface	osid.logging.LogAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.logging.batch.LogBatchAdminSession`
Used By	`osid.logging.LoggingManager`
Used By	`osid.logging.LoggingProxyManager`
Description	This session creates, updates, and deletes `Logs`. 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 `Log`, a `LogForm` is requested using `getLogFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `LogForm` 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 `LogForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `LogForm` corresponds to an attempted transaction. For updates, `LogForms` are requested to the `Log` `Id` that is to be updated using `getLogFormForUpdate()`. Similarly, the `LogForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `LogForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Logs`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateLogs
Description	Tests if this user can create `Logs`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Log` 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 `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 `Log` using the desired record types. While `LoggingManager.getLogRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Log`. Providing an empty array tests if a `Log` can be created with no records.
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 `Log`.
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 `Logs`. 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 `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 `Logs`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Log` 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 `Log` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteLog
Description	Deletes a `Log`.
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 `Id` aliases for `Logs`. 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 `Log` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasLog
Description	Adds an `Id` to a `Log` for the purpose of creating compatibility. The primary `Id` of the `Log` 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, it is reassigned to the given log `Id`.
Parameters	`osid.id.Id`	`logId`	the `Id` of a `Log`
Parameters	`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.