Docs For Class HarmoniPart

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

Located in /harmoni/core/oki2/repository/HarmoniPart.class.php (line 24)

Part
   |
   --HarmoniPart

Variable Summary

mixed $_partStructure

mixed $_recordFieldValue

Method Summary

HarmoniPart HarmoniPart (mixed $partStructure, mixed $recordFieldValue, mixed $asset)

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

object mixed getValue ()

void updateDisplayName (mixed $displayName, string $displayName )

void updateValue (object mixed $value)

false updateValueFromString (string $value, Id $id)

Variables

mixed $_partStructure (line 30)

mixed $_recordFieldValue (line 29)

Methods

Constructor HarmoniPart (line 32)

HarmoniPart HarmoniPart (mixed $partStructure, mixed $recordFieldValue, mixed $asset)

createPart (line 164)

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:

Part::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 195)

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:

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

getDisplayName (line 83)

Get the display name for this Part.

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

Redefinition of:

Part::getDisplayName(): Get the display name for this Part.

getId (line 131)

Get the unique Id for this Part.

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:

Part::getId(): Get the unique Id for this Part.

getParts (line 221)

Get all the Parts in this Part. 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:

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

getPartStructure (line 108)

Get the PartStructure associated with this Part.

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

Redefinition of:

Part::getPartStructure(): Get the PartStructure associated with this Part.

getValue (line 245)

Get the value for this Part.

return: (original type: java.io.Serializable)
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 mixed getValue ()

Redefinition of:

Part::getValue(): Get the value for this Part.

updateDisplayName (line 60)

Update the display name for this Part.

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

Redefinition of:

Part::updateDisplayName(): Update the display name for this Part.

updateValue (line 299)

Update the value for this Part.

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 updateValue (object mixed $value)

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

Redefinition of:

Part::updateValue(): Update the value for this Part.

updateValueFromString (line 264)

updates the part with a string

WARNING: NOT IN OSID

return: on failed update
since: 7/21/05
access: public

false updateValueFromString (string $value, Id $id)

string $value: this is the string value that needs to get in a part
Id $id: this is the id of the part

Inherited Methods

Inherited From Part

Part::createPart()
Part::deletePart()
Part::getDisplayName()
Part::getId()
Part::getParts()
Part::getPartStructure()
Part::getValue()
Part::updateDisplayName()
Part::updateValue()