Docs For Class Part

Class Part

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/Part.php (line 24)

Direct descendents

Class	Description
DimensionsPart	The DimensionsPart attempts to extract height, width, and mime type info from a file, in an array similar to that returned from GetImageSize() method.
FileDataPart	Each Asset has one of the AssetType supported by the Repository. There are
FileNamePart	Each Asset has one of the AssetType supported by the Repository. There are
FileSizePart	Each Asset has one of the AssetType supported by the Repository. There are
FileUrlPart	A Part for storing the file's URL
MimeTypePart	Each Asset has one of the AssetType supported by the Repository. There are
ThumbnailDataPart	Each Asset has one of the AssetType supported by the Repository. There are
ThumbnailMimeTypePart	Each Asset has one of the AssetType supported by the Repository. There are
HarmoniPart	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 PartStructure getPartStructure ()

object mixed getValue ()

void updateDisplayName (mixed $displayName, string $displayName )

void updateValue (object mixed $value)

Methods

createPart (line 147)

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:

DimensionsPart::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.
FileDataPart::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.
FileNamePart::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.
FileSizePart::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.
FileUrlPart::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.
MimeTypePart::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.
ThumbnailDataPart::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.
ThumbnailMimeTypePart::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.
HarmoniPart::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 173)

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:

DimensionsPart::deletePart() : Delete a Part and all its Parts.
FileDataPart::deletePart() : Delete a Part and all its Parts.
FileNamePart::deletePart() : Delete a Part and all its Parts.
FileSizePart::deletePart() : Delete a Part and all its Parts.
FileUrlPart::deletePart() : Delete a Part and all its Parts.
MimeTypePart::deletePart() : Delete a Part and all its Parts.
ThumbnailDataPart::deletePart() : Delete a Part and all its Parts.
ThumbnailMimeTypePart::deletePart() : Delete a Part and all its Parts.
HarmoniPart::deletePart() : Delete a Part and all its Parts.

getDisplayName (line 93)

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

Redefined in descendants as:

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

getId (line 70)

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

Redefined in descendants as:

DimensionsPart::getId() : Get the unique Id for this Part.
FileDataPart::getId() : Get the unique Id for this Part.
FileNamePart::getId() : Get the unique Id for this Part.
FileSizePart::getId() : Get the unique Id for this Part.
FileUrlPart::getId() : Get the unique Id for this Part.
MimeTypePart::getId() : Get the unique Id for this Part.
ThumbnailDataPart::getId() : Get the unique Id for this Part.
ThumbnailMimeTypePart::getId() : Get the unique Id for this Part.
HarmoniPart::getId() : Get the unique Id for this Part.

getParts (line 196)

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

Redefined in descendants as:

DimensionsPart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
FileDataPart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
FileNamePart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
FileSizePart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
FileUrlPart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
MimeTypePart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
ThumbnailDataPart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
ThumbnailMimeTypePart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.
HarmoniPart::getParts() : Get all the Parts in this Part. Iterators return a set, one at a time.

getPartStructure (line 116)

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

Redefined in descendants as:

DimensionsPart::getPartStructure() : Get the PartStructure associated with this Part.
FileDataPart::getPartStructure() : Get the PartStructure associated with this Part.
FileNamePart::getPartStructure() : Get the PartStructure associated with this Part.
FileSizePart::getPartStructure() : Get the PartStructure associated with this Part.
FileUrlPart::getPartStructure() : Get the PartStructure associated with this Part.
MimeTypePart::getPartStructure() : Get the PartStructure associated with this Part.
ThumbnailDataPart::getPartStructure() : Get the PartStructure associated with this Part.
ThumbnailMimeTypePart::getPartStructure() : Get the PartStructure associated with this Part.
HarmoniPart::getPartStructure() : Get the PartStructure associated with this Part.

getValue (line 219)

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

Redefined in descendants as:

DimensionsPart::getValue() : Get the value for this Part.
FileDataPart::getValue() : Get the value for this Part.
FileSystemFileDataPart::getValue() : Get the value for this Part.
FileNamePart::getValue() : Get the value for this Part.
FileSizePart::getValue() : Get the value for this Part.
FileUrlPart::getValue() : Get the value for this Part.
MimeTypePart::getValue() : Get the value for this Part.
ThumbnailDataPart::getValue() : Get the value for this Part.
ThumbnailMimeTypePart::getValue() : Get the value for this Part.
HarmoniPart::getValue() : Get the value for this Part.

updateDisplayName (line 47)

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

Redefined in descendants as:

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

updateValue (line 244)

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)

Redefined in descendants as:

DimensionsPart::updateValue() : Update the value for this Part.
FileDataPart::updateValue() : Update the value for this Part.
FileSystemFileDataPart::updateValue() : Update the value for this Part.
FileNamePart::updateValue() : Update the value for this Part.
FileSizePart::updateValue() : Update the value for this Part.
RemoteFileSizePart::updateValue() : Update the value for this Part.
FileUrlPart::updateValue() : Update the value for this Part.
MimeTypePart::updateValue() : Update the value for this Part.
ThumbnailDataPart::updateValue() : Update the value for this Part.
ThumbnailMimeTypePart::updateValue() : Update the value for this Part.
HarmoniPart::updateValue() : Update the value for this Part.

Documentation generated on Wed, 19 Sep 2007 10:25:27 -0400 by phpDocumentor 1.3.0RC3