Docs For Class RemoteFileRecord

Description

Remote fileRecords are just like FileRecords, but they reference file-data that lies at a remote web-accessible location.

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>

version: $Id: RemoteFileRecord.class.php,v 1.3 2007/09/11 17:40:57 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 12/5/06

Located in /harmoni/core/oki2/repository/File/RemoteFileRecord.class.php (line 40)

RecordInterface
   |
   --FileRecord
      |
      --RemoteFileRecord

Method Summary

object RemoteFileRecord (<##> $recordStructure, mixed $id, mixed $configuration, mixed $asset)

void addFileDataPart ($recordStructure $recordStructure)

void deletePart (mixed $partId, object Id $partId )

boolean _isLastPart (string $idString)

void _loadParts ()

Variables

Inherited Variables

Inherited from FileRecord

FileRecord::$_id
FileRecord::$_parts
FileRecord::$_partsLoaded
FileRecord::$_recordStructure

Methods

Constructor RemoteFileRecord (line 52)

Constructor

since: 12/5/06
access: public

object RemoteFileRecord (<##> $recordStructure, mixed $id, mixed $configuration, mixed $asset)

<##> $recordStructure

addFileDataPart (line 79)

Add a fileDataPart

since: 12/6/06
access: public

void addFileDataPart ($recordStructure $recordStructure)

$recordStructure $recordStructure

Redefinition of:

FileRecord::addFileDataPart(): Add a fileDataPart

deletePart (line 105)

Delete a Part and all its Parts.

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 deletePart (mixed $partId, object Id $partId )

object Id $partId

Redefinition of:

FileRecord::deletePart(): Delete a Part and all its Parts.

_isLastPart (line 152)

Return TRUE if the Part of the passed Id is the last one, and the whole schebang should be deleted.

WARNING: NOT IN OSID - Use at your own risk

since: 10/25/04
access: private

boolean _isLastPart (string $idString)

string $idString

Redefinition of:

FileRecord::_isLastPart(): Return TRUE if the Part of the passed Id is the last one, and the whole schebang should be deleted.

_loadParts (line 204)

Do a single query to load all of the small-valued parts for the record; that is, everything but the file and thumb data.

since: 11/17/05
access: private

void _loadParts ()

Redefinition of:

FileRecord::_loadParts(): Do a single query to load all of the small-valued parts for the record; that is, everything but the file and thumb data.

Inherited Methods

Inherited From FileRecord

FileRecord::FileRecord()
FileRecord::addFileDataPart()
FileRecord::createPart()
FileRecord::deletePart()
FileRecord::getId()
FileRecord::getPart()
FileRecord::getParts()
FileRecord::getPartsByPartStructure()
FileRecord::getRecordStructure()
FileRecord::isMultivalued()
FileRecord::_isLastPart()
FileRecord::_loadParts()

Inherited From RecordInterface

RecordInterface::createPart()
RecordInterface::deletePart()
RecordInterface::getDisplayName()
RecordInterface::getId()
RecordInterface::getParts()
RecordInterface::getRecordStructure()
RecordInterface::updateDisplayName()