Class FilingManager

Description

<p> FilingManager:

  • creates root Cabinets,
  • deletes CabinetEntries,
  • gets root Cabinets and CabinetEntries.
</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/filing/FilingManager.php (line 51)

OsidManager
   |
   --FilingManager
Method Summary
object Cabinet createRootCabinet (mixed $displayName, string $displayName )
void delete (mixed $cabinetEntryId, object Id $cabinetEntryId )
Methods
createRootCabinet (line 115)

Create a new root Cabinet with the given name. The name must not include this Cabinet's separationCharacter.

  • access: public
  • throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR, ITEM_ALREADY_EXISTS, NAME_CONTAINS_ILLEGAL_CHARS
object Cabinet createRootCabinet (mixed $displayName, string $displayName )
  • string $displayName
delete (line 140)

Deletes this CabinetEntry. If the CabinetEntry is a Cabinet it must be empty, and the Owner of the Manager must have sufficient permissions to perform this action.

  • access: public
  • throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR, DELETE_FAILED, CABINET_NOT_EMPTY, ITEM_DOES_NOT_EXIST
void delete (mixed $cabinetEntryId, object Id $cabinetEntryId )
getCabinetEntry (line 90)

Get a CabinetEntry by ID.

  • access: public
  • throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR, ITEM_DOES_NOT_EXIST
object CabinetEntry getCabinetEntry (mixed $id, object Id $id )
getRoots (line 68)

Get all the root Cabinets currently available in this Manager.

  • access: public
  • throws: object FilingException An exception with one of the following messages defined in org.osid.filing.FilingException may be thrown: PERMISSION_DENIED, IO_ERROR

Inherited Methods

Inherited From OsidManager

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

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