File Source for Part.php

<?php 
 
/**
 * Each Asset has one of the AssetType supported by the Repository.  There are
 * also zero or more RecordStructures required by the Repository for each
 * AssetType. RecordStructures provide structural information.  The values for
 * a given Asset's RecordStructure are stored in a Record.  RecordStructures
 * can contain sub-elements which are referred to as PartStructures.  The
 * structure defined in the RecordStructure and its PartStructures is used in
 * for any Records for the Asset.  Records have Parts which parallel
 * PartStructures.
 * 
 * <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 Part
{
    /**
     * Update the display name for this Part.
     * 
     * @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 unique Id for this Part.
     *  
     * @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 display name for this Part.
     *  
     * @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 PartStructure associated with this Part.
     *  
     * @return object PartStructure 
     * 
     * @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 getPartStructure () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Create a Part.  Records are composed of Parts. Parts can also contain
     * other Parts.  Each Record is associated with a specific RecordStructure
     * and each Part is associated with a specific PartStructure.
     * 
     * @param object Id $partStructureId 
     * @param object mixed $value (original type: java.io.Serializable)
     *  
     * @return object Part 
     * 
     * @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 createPart ( $partStructureId, $value ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Delete a Part and all its Parts.
     * 
     * @param object Id $partId 
     * 
     * @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 deletePart ( $partId ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get all the Parts in this Part.  Iterators return a set, one at a time.
     *  
     * @return object PartIterator 
     * 
     * @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 getParts () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the value for this Part.
     *  
     * @return object mixed (original type: java.io.Serializable)
     * 
     * @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 getValue () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Update the value for this Part.
     * 
     * @param object mixed $value (original type: java.io.Serializable)
     * 
     * @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 updateValue ( $value ) { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>
Source for file Part.php
