Docs For Class SetManager

Description

The SetManager maintains a configuration and retreives Sets with that configuration.

version: $Id: SetManager.class.php,v 1.13 2007/09/04 20:25:49 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/sets/SetManager.class.php (line 16)

Variable Summary

integer $_dbIndex

array $_persistentSets

Method Summary

SetManager SetManager (integer $dbIndex)

void assignConfiguration (object Properties $configuration)

void assignOsidContext (mixed $context, object OsidContext $context )

void deletePersistentSet (object Id $id)

void deleteTemporarySet (object Id $id)

object OsidContext getOsidContext ()

object SetInterface getPersistentSet (object Id $id)

object SetInterface getTemporarySet (object Id $id)

object PersistentOrderedSet persist (object OrderedSet $set)

Variables

integer $_dbIndex (line 22)

var: The index of the database connection to use.
access: private

array $_persistentSets (line 28)

var: An array of created Set objects
access: private

Methods

Constructor SetManager (line 37)

The constructor

since: 6/28/04
access: public

SetManager SetManager (integer $dbIndex)

integer $dbIndex: The database index to use

assignConfiguration (line 67)

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)

assignOsidContext (line 103)

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

deletePersistentSet (line 135)

Remove all of the items from the set, thereby deleting it.

since: 6/28/04
access: public

void deletePersistentSet (object Id $id)

object Id $id: The Id of the Set to delete.

deleteTemporarySet (line 167)

Remove all of the items from the set, thereby deleting it.

since: 6/28/04
access: public

void deleteTemporarySet (object Id $id)

object Id $id: The Id of the Set to delete.

getOsidContext (line 88)

Return context of this OsidManager.

access: public
throws: object OsidException

object OsidContext getOsidContext ()

getPersistentSet (line 117)

Get a Set object of the specified Id. The Set does not have to have been created previously and any changes to the set will be persisted automatically.

since: 6/28/04
access: public

object SetInterface getPersistentSet (object Id $id)

object Id $id: The Id of the set to get.

getTemporarySet (line 150)

Get a Set object of the specified Id. The Set does not have to have been created previously and any changes to the set will be persisted automatically for the remainder of the SESSION.

since: 6/28/04
access: public

object SetInterface getTemporarySet (object Id $id)

object Id $id: The Id of the set to get.

persist (line 181)

Persist a Set and return the new persistent version of it. If A persistent Set of the same Id already exists, the new one will replace it.

since: 8/5/05
access: public

object PersistentOrderedSet persist (object OrderedSet $set)

object OrderedSet $set