Source for file Repository.php

<?php 
 
/**
 * Repository manages Assets of various Types and information about the Assets.
 * Assets are created, persisted, and validated by the Repository.  When
 * initially created, an Asset has an immutable Type and unique Id and its
 * validation status is false.  In this state, all methods can be called, but
 * integrity checks are not enforced.  When the Asset and its Records are
 * ready to be validated, the validateAsset method checks the Asset and sets
 * the validation status.  When working with a valid Asset, all methods
 * include integrity checks and an exception is thrown if the activity would
 * result in an inappropriate state.  Optionally, the invalidateAsset method
 * can be called to release the requirement for integrity checks, but the
 * Asset will not become valid again, until validateAsset is called and the
 * entire Asset is checked.
 * 
 * <p>
 * OSID Version: 2.0
 * </p>
 * 
 * <p>
 * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
 * O.K.I&#46; OSID Definition License}.
 * </p>
 * 
 * @package org.osid.repository
 */
class Repository
{ 
    /**
     * Update the display name for this Repository.
     * 
     * @param string $displayName 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateDisplayName ( $displayName ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the display name for this Repository.
     *  
     * @return string 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getDisplayName () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the unique Id for this Repository.
     *  
     * @return object Id 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the RepositoryType of this Repository.
     *  
     * @return object Type 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getType () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the description for this Repository.
     *  
     * @return string 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getDescription () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the description for this Repository.
     * 
     * @param string $description 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function updateDescription ( $description ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create a new Asset of this AssetType in this Repository.  The
     * implementation of this method sets the Id for the new object.
     * 
     * @param string $displayName 
     * @param string $description 
     * @param object Type $assetType 
     *  
     * @return object Asset 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function createAsset ( $displayName, $description, $assetType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete an Asset from this Repository.
     * 
     * @param object Id $assetId 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function deleteAsset ( $assetId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Assets in this Repository.  Iterators return a set, one at a
     * time.
     *  
     * @return object AssetIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getAssets () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Assets of the specified AssetType in this Asset.  Iterators
     * return a set, one at a time.
     * 
     * @param object Type $assetType 
     *  
     * @return object AssetIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getAssetsByType ( $assetType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the AssetTypes in this Repository.  AssetTypes are used to
     * categorize Assets.  Iterators return a set, one at a time.
     *  
     * @return object TypeIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getAssetTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Properties of this Type associated with this Repository.
     * 
     * @param object Type $propertiesType 
     *  
     * @return object Properties 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getPropertiesByType ( $propertiesType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Property Types for  Repository.
     *  
     * @return object TypeIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getPropertyTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Properties associated with this Repository.
     *  
     * @return object PropertiesIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getProperties () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the RecordStructures in this Repository.  RecordStructures are
     * used to categorize information about Assets.  Iterators return a set,
     * one at a time.
     *  
     * @return object RecordStructureIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getRecordStructures () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the RecordStructures with the specified RecordStructureType in
     * this Repository.  RecordStructures are used to categorize information
     * about Assets.  Iterators return a set, one at a time.
     * 
     * @param object Type $recordStructureType 
     *  
     * @return object RecordStructureIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getRecordStructuresByType ( $recordStructureType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the RecordStructures that this AssetType must support.
     * RecordStructures are used to categorize information about Assets.
     * Iterators return a set, one at a time.
     * 
     * @param object Type $assetType 
     *  
     * @return object RecordStructureIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getMandatoryRecordStructures ( $assetType ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the SearchTypes supported by this Repository.  Iterators return
     * a set, one at a time.
     *  
     * @return object TypeIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getSearchTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the StatusTypes supported by this Repository.  Iterators return
     * a set, one at a time.
     *  
     * @return object TypeIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getStatusTypes () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the StatusType of the Asset with the specified unique Id.
     * 
     * @param object Id $assetId 
     *  
     * @return object Type 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getStatus ( $assetId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Validate all the Records for an Asset and set its status Type
     * accordingly.  If the Asset is valid, return true; otherwise return
     * false.  The implementation may throw an Exception for any validation
     * failures and use the Exception's message to identify specific causes.
     * 
     * @param object Id $assetId 
     *  
     * @return boolean 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function validateAsset ( $assetId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Set the Asset's status Type accordingly and relax validation checking
     * when creating Records and Parts or updating Parts' values.
     * 
     * @param object Id $assetId 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function invalidateAsset ( $assetId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the Asset with the specified unique Id.
     * 
     * @param object Id $assetId 
     *  
     * @return object Asset 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function getAsset ( $assetId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * 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.
     * 
     * @param object Id $assetId 
     * @param int $date 
     *  
     * @return object Asset 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#NO_OBJECT_WITH_THIS_DATE
     *          NO_OBJECT_WITH_THIS_DATE}
     * 
     * @access public
     */
    function getAssetByDate ( $assetId, $date ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the dates for the Asset with the specified unique Id.  These
     * dates allows a Repository implementation to support Asset versioning.
     * 
     * @param object Id $assetId 
     *  
     * @return object LongValueIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}
     * 
     * @access public
     */
    function getAssetDates ( $assetId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Perform a search of the specified Type and get all the Assets that
     * satisfy the SearchCriteria.  Iterators return a set, one at a time.
     * 
     * @param object mixed $searchCriteria (original type: java.io.Serializable)
     * @param object Type $searchType 
     * @param object Properties $searchProperties 
     *  
     * @return object AssetIterator 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_TYPE
     *          UNKNOWN_TYPE}
     * 
     * @access public
     */
    function getAssetsBySearch ( $searchCriteria, $searchType, $searchProperties ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create a copy of an Asset.  The Id, AssetType, and Repository for the
     * new Asset is set by the implementation.  All Records are similarly
     * copied.
     * 
     * @param object Asset $asset 
     *  
     * @return object Id 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}, {@link }
     *          org.osid.repository.RepositoryException#NULL_ARGUMENT
     *          NULL_ARGUMENT}, {@link }
     *          org.osid.repository.RepositoryException#UNKNOWN_ID UNKNOWN_ID}
     * 
     * @access public
     */
    function copyAsset ( $asset ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * This method indicates whether this implementation supports Repository
     * methods getAssetsDates() and getAssetByDate()
     *  
     * @return boolean 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function supportsVersioning () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * This method indicates whether this implementation supports Repository
     * methods: copyAsset, deleteAsset, invalidateAsset, updateDescription,
     * updateDisplayName. Asset methods: addAsset, copyRecordStructure,
     * createRecord, deleteRecord, inheritRecordStructure, removeAsset,
     * updateContent, updateDescription, updateDisplayName,
     * updateEffectiveDate, updateExpirationDate. Part methods: createPart,
     * deletePart, updateDisplayName, updateValue. PartStructure methods:
     * updateDisplayName, validatePart. Record methods: createPart,
     * deletePart, updateDisplayName. RecordStructure methods:
     * updateDisplayName, validateRecord.
     *  
     * @return boolean 
     * 
     * @throws object RepositoryException An exception with one of
     *          the following messages defined in
     *          org.osid.repository.RepositoryException may be thrown: {@link }
     *          org.osid.repository.RepositoryException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.repository.RepositoryException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.repository.RepositoryException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.repository.RepositoryException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function supportsUpdate () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>