Class RepositoryManager

Description
Description | Descendents | Methods (details)

<p> The RepositoryManager supports creating and deleting Repositories and Assets as well as getting the various Types used.

</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/repository/RepositoryManager.php (line 40) 

OsidManager
   |
   --RepositoryManager
Direct descendents
Description | Descendents | Methods (details)
Class Description
HarmoniRepositoryManager <p> The RepositoryManager supports creating and deleting Repositories and Assets as well as getting the various Types used.
Method Summary
Description | Descendents | Methods (details)
object Id copyAsset (object Repository $repository, mixed $assetId, object Id $assetId )
object Repository createRepository (string $displayName, string $description, mixed $repositoryType, object Type $repositoryType )
void deleteRepository (mixed $repositoryId, object Id $repositoryId )
object Asset getAsset (mixed $assetId, object Id $assetId )
object Asset getAssetByDate (object Id $assetId, mixed $date, int $date )
object LongValueIterator getAssetDates (mixed $assetId, object Id $assetId )
object AssetIterator getAssetsBySearch (object Repository[] $repositories, object mixed $searchCriteria, object Type $searchType, mixed $searchProperties, object Properties $searchProperties )
object RepositoryIterator getRepositories ()
object RepositoryIterator getRepositoriesByType (mixed $repositoryType, object Type $repositoryType )
object Repository getRepository (mixed $repositoryId, object Id $repositoryId )
object TypeIterator getRepositoryTypes ()
Methods
Description | Descendents | Methods (details)
copyAsset (line 337)

Create in a Repository a copy of an Asset. The Id, AssetType, and Repository for the new Asset is set by the implementation. All Records are similarly copied.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID
object Id copyAsset (object Repository $repository, mixed $assetId, object Id $assetId )
Redefined in descendants as:
  • HarmoniRepositoryManager::copyAsset() : Create in a Repository a copy of an Asset. The Id, AssetType, and Repository for the new Asset is set by the implementation. All Records are similarly copied.
createRepository (line 71)

Create a new Repository of the specified Type. The implementation of this method sets the Id for the new object.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE
object Repository createRepository (string $displayName, string $description, mixed $repositoryType, object Type $repositoryType )
  • string $displayName
  • string $description
  • object Type $repositoryType
Redefined in descendants as:
deleteRepository (line 97)

Delete a Repository.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID
void deleteRepository (mixed $repositoryId, object Id $repositoryId )
Redefined in descendants as:
getAsset (line 210)

Get the Asset with the specified unique Id.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID
object Asset getAsset (mixed $assetId, object Id $assetId )
Redefined in descendants as:
getAssetByDate (line 242)

Get the Asset with the specified unique Id that is appropriate for the date specified. The specified date allows a Repository implementation to support Asset versioning.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, NO_OBJECT_WITH_THIS_DATE
object Asset getAssetByDate (object Id $assetId, mixed $date, int $date )
Redefined in descendants as:
getAssetDates (line 270)

Get all the dates for the Asset with the specified unique Id. These dates allows a Repository implementation to support Asset versioning.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
object LongValueIterator getAssetDates (mixed $assetId, object Id $assetId )
Redefined in descendants as:
getAssetsBySearch (line 306)

Perform a search of the specified Type and get all the Assets that satisfy the SearchCriteria. The search is performed for all specified Repositories. Iterators return a set, one at a time.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE, UNKNOWN_REPOSITORY
object AssetIterator getAssetsBySearch (object Repository[] $repositories, object mixed $searchCriteria, object Type $searchType, mixed $searchProperties, object Properties $searchProperties )
  • object Repository[] $repositories
  • object mixed $searchCriteria: (original type: java.io.Serializable)
  • object Type $searchType
  • object Properties $searchProperties
Redefined in descendants as:
  • HarmoniRepositoryManager::getAssetsBySearch() : Perform a search of the specified Type and get all the Assets that satisfy the SearchCriteria. The search is performed for all specified Repositories. Iterators return a set, one at a time.
getRepositories (line 124)

Get all the Repositories. Iterators return a set, one at a time.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, CONFIGURATION_ERROR, UNIMPLEMENTED
object RepositoryIterator getRepositories ()
Redefined in descendants as:
getRepositoriesByType (line 154)

Get all the Repositories of the specified Type. Iterators return a set, one at a time.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE
object RepositoryIterator getRepositoriesByType (mixed $repositoryType, object Type $repositoryType )
Redefined in descendants as:
getRepository (line 182)

Get the Repository with the specified unique Id.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID
object Repository getRepository (mixed $repositoryId, object Id $repositoryId )
Redefined in descendants as:
getRepositoryTypes (line 362)

Get all the RepositoryTypes in this RepositoryManager. RepositoryTypes are used to categorize Repositories. Iterators return a set, one at a time.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object TypeIterator getRepositoryTypes ()
Redefined in descendants as:

Inherited Methods

Inherited From OsidManager

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

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