Class HarmoniLoggingManager

Description
Description | Vars (details) | Methods (details)

<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/core/oki2/logging/HarmoniLoggingManager.class.php (line 53) 

OsidManager
   |
   --LoggingManager
      |
      --HarmoniLoggingManager
Variable Summary
Description | Vars (details) | Methods (details)
integer $_dbIndex
Method Summary
Description | Vars (details) | Methods (details)
void assignConfiguration (object Properties $configuration)
void assignOsidContext (mixed $context, object OsidContext $context )
object WritableLog createLog (mixed $logName, string $logName )
void deleteLog (mixed $logName, string $logName )
object TypeIterator getFormatTypes ()
object ReadableLog getLogForReading (mixed $logName, string $logName )
object WritableLog getLogForWriting (mixed $logName, string $logName )
object StringIterator getLogNamesForReading ()
object StringIterator getLogNamesForWriting ()
object OsidContext getOsidContext ()
object TypeIterator getPriorityTypes ()
boolean supportsReading ()
Variables
Description | Vars (details) | Methods (details)
integer $_dbIndex (line 61)

The database connection as returned by the DBHandler.

  • var: _dbIndex
  • access: private
Methods
Description | Vars (details) Methods (details)
assignConfiguration (line 83)

Assign the configuration of this Manager. Valid configuration options are as

follows: database_index integer database_name string

  • access: public
  • throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void assignConfiguration (object Properties $configuration)
  • object Properties $configuration: (original type: java.util.Properties)
Redefinition of:
OsidManager::assignConfiguration()
Assign the configuration of this OsidManager.
assignOsidContext (line 119)

Assign the context of this OsidManager.

  • access: public
  • throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: NULL_ARGUMENT
void assignOsidContext (mixed $context, object OsidContext $context )
  • object OsidContext $context
Redefinition of:
OsidManager::assignOsidContext()
Assign the context of this OsidManager.
createLog (line 356)

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
Redefinition of:
LoggingManager::createLog()
Create a Writable Log.
deleteLog (line 379)

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
Redefinition of:
LoggingManager::deleteLog()
Delete the log with the specified name.
getFormatTypes (line 141)

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 ()
Redefinition of:
LoggingManager::getFormatTypes()
Return the format types available with this implementation.
getLogForReading (line 330)

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
Redefinition of:
LoggingManager::getLogForReading()
Get an existing log for reading.
getLogForWriting (line 280)

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
Redefinition of:
LoggingManager::getLogForWriting()
Get an existing log for writing.
getLogNamesForReading (line 305)

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 ()
Redefinition of:
LoggingManager::getLogNamesForReading()
Return the names of readable Logs.
getLogNamesForWriting (line 238)

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 ()
Redefinition of:
LoggingManager::getLogNamesForWriting()
Return the names of writable Logs.
getOsidContext (line 104)

Return context of this OsidManager.

  • access: public
  • throws: object OsidException
object OsidContext getOsidContext ()
Redefinition of:
OsidManager::getOsidContext()
Return context of this OsidManager.
getPriorityTypes (line 191)

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 ()
Redefinition of:
LoggingManager::getPriorityTypes()
Return the priority types available with this implementation.
supportsReading (line 435)

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 ()
Redefinition of:
LoggingManager::supportsReading()
This method indicates whether this implementation supports the ReadableLog interface and the LoggingManager methods: getLogForReading and getLogNamesForReading.

Inherited Methods

Inherited From LoggingManager

LoggingManager::createLog()
LoggingManager::deleteLog()
LoggingManager::getFormatTypes()
LoggingManager::getLogForReading()
LoggingManager::getLogForWriting()
LoggingManager::getLogNamesForReading()
LoggingManager::getLogNamesForWriting()
LoggingManager::getPriorityTypes()
LoggingManager::supportsReading()

Inherited From OsidManager

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

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