Class HarmoniReadableLog

Description

ReadableLog allows reading of its entries.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/core/oki2/logging/HarmoniReadableLog.class.php (line 29)

ReadableLog
   |
   --HarmoniReadableLog
Direct descendents
Class Description
HarmoniWritableLog Interface WritableLog allows writing of entry items, format types, priority types to a log. Two methods are used to write the entryItems:
Method Summary
object HarmoniReadableLog (string $name, mixed $dbIndex)
string getDisplayName ()
object EntryIterator getEntries (object Type $formatType, mixed $priorityType, object Type $priorityType )
object EntryIterator getEntriesBySearch (mixed $searchCriteria, object Type $searchType, object Type $formatType, mixed $priorityType, object Type $priorityType )
Methods
Constructor HarmoniReadableLog (line 41)

Constructor

  • since: 3/1/06
  • access: public
object HarmoniReadableLog (string $name, mixed $dbIndex)
  • string $name
getDisplayName (line 66)

Get the display name for this ReadableLog.

  • 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
string getDisplayName ()

Redefinition of:
ReadableLog::getDisplayName()
Get the display name for this ReadableLog.
getEntries (line 94)

Return the ReadableLog Entries in a last-in, first-out (LIFO) order.

  • 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, NULL_ARGUMENT, UNKNOWN_TYPE
object EntryIterator getEntries (object Type $formatType, mixed $priorityType, object Type $priorityType )
  • object Type $formatType
  • object Type $priorityType

Redefinition of:
ReadableLog::getEntries()
Return the ReadableLog Entries in a last-in, first-out (LIFO) order.
getEntriesBySearch (line 128)

Return the ReadableLog Entries in a last-in, first-out (LIFO) order.

Limit by the search criteria.

Warning: NOT IN OSID

  • 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, NULL_ARGUMENT, UNKNOWN_TYPE
object EntryIterator getEntriesBySearch (mixed $searchCriteria, object Type $searchType, object Type $formatType, mixed $priorityType, object Type $priorityType )
  • mixed $searchCriteria
  • object Type $searchType
  • object Type $formatType
  • object Type $priorityType

Inherited Methods

Inherited From ReadableLog

ReadableLog::getDisplayName()
ReadableLog::getEntries()

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