Docs For Class RecordInterface

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>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/repository/Record.php (line 28)

Direct descendents

Class	Description
FileRecord	Each Asset has one of the AssetType supported by the Repository. There are
HarmoniRecord	Each Asset has one of the AssetType supported by the Repository. There are

Method Summary

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

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

string getDisplayName ()

object Id getId ()

object PartIterator getParts ()

object RecordStructure getRecordStructure ()

void updateDisplayName (mixed $displayName, string $displayName )

Methods

createPart (line 128)

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)

Redefined in descendants as:

FileRecord::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.
HarmoniRecord::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 154)

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

Redefined in descendants as:

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

getDisplayName (line 74)

Get the display name 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

string getDisplayName ()

getId (line 97)

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

Redefined in descendants as:

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

getParts (line 177)

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

Redefined in descendants as:

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

getRecordStructure (line 200)

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

Redefined in descendants as:

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

updateDisplayName (line 51)

Update the display name 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, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName