OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogAdminSession
Implementsosid.OsidSession
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.

MethodcanCreateLogs
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.

Returnboolean false if Log creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateLogWithRecordTypes
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.

Parametersosid.type.Type[]logRecordTypesarray of log record types
Returnboolean true if Log creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT logRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetLogFormForCreate
Description

Gets the log form for creating new logs. A new form should be requested for each create transaction.

Parametersosid.type.Type[]logRecordTypesarray of log record types
Returnosid.logging.LogFormthe log form
ErrorsNULL_ARGUMENT logRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form with requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateLog
Description

Creates a new Log.

Parametersosid.logging.LogFormlogFormthe form for this Log
Returnosid.logging.Logthe new Log
ErrorsILLEGAL_STATE logForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT logForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED logForm did not originate from getLogFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateLogs
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.

Returnboolean false if Log modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLogFormForUpdate
Description

Gets the log form for updating an existing log. A new log form should be requested for each update transaction.

Parametersosid.id.IdlogIdthe Id of the Log
Returnosid.logging.LogFormthe log form
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateLog
Description

Updates an existing log.

Parametersosid.logging.LogFormlogFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE logForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT logId or logForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED logForm did not originate from getLogFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteLogs
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.

Returnboolean false if Log deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteLog
Description

Deletes a Log.

Parametersosid.id.IdlogIdthe Id of the Log to remove
ErrorsNOT_FOUND logId not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageLogAliases
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.

Returnboolean false if Log aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasLog
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.

Parametersosid.id.IdlogIdthe Id of a Log
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND logId not found
NULL_ARGUMENT logId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.