Docs For Class HarmoniRecord

Description

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: HarmoniRecord.class.php,v 1.24 2007/09/04 20:25:43 adamfranco Exp $
license: GNU General Public License
copyright: Copyright ©2005, Middlebury College

Located in /harmoni/core/oki2/repository/HarmoniRecord.class.php (line 30)

RecordInterface
   |
   --HarmoniRecord

Variable Summary

mixed $_createdParts

mixed $_record

mixed $_recordStructure

Method Summary

HarmoniRecord HarmoniRecord (mixed $recordStructure, mixed $record, mixed $asset)

object Part createPart (object Id $partStructureId, object mixed $value)

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

object Id getId ()

object HarmoniPart getPart (object HarmoniId $id)

object PartIterator getParts ()

object PartIterator getPartsByPartStructure (mixed $partStructureId, object Id $partStructureId )

object RecordStructure getRecordStructure ()

boolean isMultivalued ()

Variables

mixed $_createdParts (line 37)

mixed $_record (line 34)

mixed $_recordStructure (line 35)

Methods

Constructor HarmoniRecord (line 39)

HarmoniRecord HarmoniRecord (mixed $recordStructure, mixed $record, mixed $asset)

createPart (line 99)

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.

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 Part createPart (object Id $partStructureId, object mixed $value)

object Id $partStructureId
object mixed $value: (original type: java.io.Serializable)

Redefinition of:

RecordInterface::createPart(): 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.

deletePart (line 171)

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:

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

getId (line 66)

Get the unique Id for this Record.

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 Id getId ()

Redefinition of:

RecordInterface::getId(): Get the unique Id for this Record.

getPart (line 244)

Get the part from the record that matches the passed Id

WARNING: NOT IN OSID

since: 10/10/05
access: public

object HarmoniPart getPart (object HarmoniId $id)

object HarmoniId $id

getParts (line 208)

Get all the Parts in the Record. 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 PartIterator getParts ()

Redefinition of:

RecordInterface::getParts(): Get all the Parts in the Record. Iterators return a set, one at a time.

getPartsByPartStructure (line 318)

Get the Parts of the Records for this Asset that are based on this RecordStructure PartStructure's unique Id.

WARNING: NOT IN OSID (as of July 2005)

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 PartIterator getPartsByPartStructure (mixed $partStructureId, object Id $partStructureId )

object Id $partStructureId

getRecordStructure (line 287)

Get the RecordStructure associated with this Record.

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 RecordStructure getRecordStructure ()

Redefinition of:

RecordInterface::getRecordStructure(): Get the RecordStructure associated with this Record.

isMultivalued (line 264)

Return true if this Record is multi-valued; false otherwise. This is determined by the implementation.

WARNING: NOT IN OSID

throws: osid.dr.DigitalRepositoryException An exception with one of the following messages defined in osid.dr.DigitalRepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

boolean isMultivalued ()

Inherited Methods

Inherited From RecordInterface

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