Class LoggingManager

Description

<p> LoggingManager handles creating, deleting, and getting logs for reading or writing. All log Entries have a formatType, a priorityType, and a timestamp.

</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/logging/LoggingManager.php (line 41)

OsidManager
   |
   --LoggingManager
Direct descendents
Class Description
HarmoniLoggingManager <p> LoggingManager handles creating, deleting, and getting logs for reading or writing. All log Entries have a formatType, a priorityType, and a timestamp.
Method Summary
object WritableLog createLog (mixed $logName, string $logName )
void deleteLog (mixed $logName, string $logName )
object ReadableLog getLogForReading (mixed $logName, string $logName )
object WritableLog getLogForWriting (mixed $logName, string $logName )
boolean supportsReading ()
Methods
createLog (line 204)

Create a Writable Log.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, DUPLICATE_NAME
object WritableLog createLog (mixed $logName, string $logName )
  • string $logName

Redefined in descendants as:
deleteLog (line 227)

Delete the log with the specified name.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNKNOWN_NAME
void deleteLog (mixed $logName, string $logName )
  • string $logName

Redefined in descendants as:
getFormatTypes (line 62)

Return the format types available with this implementation.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED
object TypeIterator getFormatTypes ()

Redefined in descendants as:
getLogForReading (line 178)

Get an existing log for reading.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNKNOWN_NAME
object ReadableLog getLogForReading (mixed $logName, string $logName )
  • string $logName

Redefined in descendants as:
getLogForWriting (line 131)

Get an existing log for writing.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNKNOWN_NAME
object WritableLog getLogForWriting (mixed $logName, string $logName )
  • string $logName

Redefined in descendants as:
getLogNamesForReading (line 153)

Return the names of readable Logs.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED
object StringIterator getLogNamesForReading ()

Redefined in descendants as:
getLogNamesForWriting (line 106)

Return the names of writable Logs.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED
object StringIterator getLogNamesForWriting ()

Redefined in descendants as:
getPriorityTypes (line 84)

Return the priority types available with this implementation.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED
object TypeIterator getPriorityTypes ()

Redefined in descendants as:
supportsReading (line 251)

This method indicates whether this implementation supports the ReadableLog interface and the LoggingManager methods: getLogForReading and getLogNamesForReading.

  • access: public
  • throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED
boolean supportsReading ()

Redefined in descendants as:
  • HarmoniLoggingManager::supportsReading() : This method indicates whether this implementation supports the ReadableLog interface and the LoggingManager methods: getLogForReading and getLogNamesForReading.

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

Documentation generated on Wed, 19 Sep 2007 10:24:54 -0400 by phpDocumentor 1.3.0RC3