Docs For Class PartStructure

Class PartStructure

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

Direct descendents

Class	Description
DimensionsPartStructure	Each Asset has one of the AssetType supported by the Repository. There are
FileDataPartStructure	Each Asset has one of the AssetType supported by the Repository. There are
FileNamePartStructure	Each Asset has one of the AssetType supported by the Repository. There are
FileSizePartStructure	Each Asset has one of the AssetType supported by the Repository. There are
MimeTypePartStructure	Each Asset has one of the AssetType supported by the Repository. There are
ThumbnailDataPartStructure	Each Asset has one of the AssetType supported by the Repository. There are
ThumbnailMimeTypePartStructure	Each Asset has one of the AssetType supported by the Repository. There are
HarmoniPartStructure	Each Asset has one of the AssetType supported by the Repository. There are

Method Summary

string getDescription ()

string getDisplayName ()

object Id getId ()

object PartStructureIterator getPartStructures ()

object RecordStructure getRecordStructure ()

object Type getType ()

boolean isMandatory ()

boolean isPopulatedByRepository ()

boolean isRepeatable ()

void updateDisplayName (mixed $displayName, string $displayName )

boolean validatePart (mixed $part, object Part $part )

Methods

getDescription (line 93)

Get the description for this 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

string getDescription ()

Redefined in descendants as:

DimensionsPartStructure::getDescription() : Get the description for this PartStructure.
FileDataPartStructure::getDescription() : Get the description for this PartStructure.
FileNamePartStructure::getDescription() : Get the description for this PartStructure.
FileUrlPartStructure::getDescription() : Get the description for this PartStructure.
FileSizePartStructure::getDescription() : Get the description for this PartStructure.
MimeTypePartStructure::getDescription() : Get the description for this PartStructure.
ThumbnailDataPartStructure::getDescription() : Get the description for this PartStructure.
ThumbnailMimeTypePartStructure::getDescription() : Get the description for this PartStructure.
HarmoniPartStructure::getDescription() : Get the description for this PartStructure.

getDisplayName (line 70)

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

string getDisplayName ()

Redefined in descendants as:

DimensionsPartStructure::getDisplayName() : Get the display name for this PartStructure.
FileDataPartStructure::getDisplayName() : Get the display name for this PartStructure.
FileNamePartStructure::getDisplayName() : Get the display name for this PartStructure.
FileUrlPartStructure::getDisplayName() : Get the display name for this PartStructure.
FileSizePartStructure::getDisplayName() : Get the display name for this PartStructure.
MimeTypePartStructure::getDisplayName() : Get the display name for this PartStructure.
ThumbnailDataPartStructure::getDisplayName() : Get the display name for this PartStructure.
ThumbnailMimeTypePartStructure::getDisplayName() : Get the display name for this PartStructure.
HarmoniPartStructure::getDisplayName() : Get the display name for this PartStructure.

getId (line 116)

Get the unique Id for this 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

object Id getId ()

Redefined in descendants as:

DimensionsPartStructure::getId() : Get the unique Id for this PartStructure.
FileDataPartStructure::getId() : Get the unique Id for this PartStructure.
FileNamePartStructure::getId() : Get the unique Id for this PartStructure.
FileUrlPartStructure::getId() : Get the unique Id for this PartStructure.
FileSizePartStructure::getId() : Get the unique Id for this PartStructure.
MimeTypePartStructure::getId() : Get the unique Id for this PartStructure.
ThumbnailDataPartStructure::getId() : Get the unique Id for this PartStructure.
ThumbnailMimeTypePartStructure::getId() : Get the unique Id for this PartStructure.
HarmoniPartStructure::getId() : Get the unique Id for this PartStructure.

getPartStructures (line 258)

Get all the PartStructures in the PartStructure. 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 PartStructureIterator getPartStructures ()

Redefined in descendants as:

FileDataPartStructure::getPartStructures() : Get all the PartStructures in the PartStructure. Iterators return a set, one at a time.
FileNamePartStructure::getPartStructures() : Get all the PartStructures in the PartStructure. Iterators return a set, one at a time.
ThumbnailDataPartStructure::getPartStructures() : Get all the PartStructures in the PartStructure. Iterators return a set, one at a time.
ThumbnailMimeTypePartStructure::getPartStructures() : Get all the PartStructures in the PartStructure. Iterators return a set, one at a time.
HarmoniPartStructure::getPartStructures() : Get all the PartStructures in the PartStructure. Iterators return a set, one at a time.

getRecordStructure (line 234)

Get the RecordStructure associated with this 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

object RecordStructure getRecordStructure ()

Redefined in descendants as:

DimensionsPartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.
FileDataPartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.
FileNamePartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.
FileSizePartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.
MimeTypePartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.
ThumbnailDataPartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.
HarmoniPartStructure::getRecordStructure() : Get the RecordStructure associated with this PartStructure.

getType (line 139)

Get the Type for this 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

object Type getType ()

Redefined in descendants as:

DimensionsPartStructure::getType() : Get the Type for this PartStructure.
FileDataPartStructure::getType() : Get the Type for this PartStructure.
FileNamePartStructure::getType() : Get the Type for this PartStructure.
FileSizePartStructure::getType() : Get the Type for this PartStructure.
MimeTypePartStructure::getType() : Get the Type for this PartStructure.
ThumbnailDataPartStructure::getType() : Get the Type for this PartStructure.
ThumbnailMimeTypePartStructure::getType() : Get the Type for this PartStructure.
HarmoniPartStructure::getType() : Get the Type for this PartStructure.

isMandatory (line 187)

Return true if this PartStructure is mandatory; false otherwise.

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

boolean isMandatory ()

Redefined in descendants as:

DimensionsPartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
FileDataPartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
FileNamePartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
FileSizePartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
MimeTypePartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
ThumbnailDataPartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
ThumbnailMimeTypePartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.
HarmoniPartStructure::isMandatory() : Return true if this PartStructure is mandatory; false otherwise.

isPopulatedByRepository (line 164)

Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.

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

boolean isPopulatedByRepository ()

Redefined in descendants as:

DimensionsPartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
FileDataPartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
FileNamePartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
FileSizePartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
RemoteFileSizePartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
MimeTypePartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
ThumbnailDataPartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
ThumbnailMimeTypePartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.
HarmoniPartStructure::isPopulatedByRepository() : Return true if this PartStructure is automatically populated by the Repository; false otherwise. Examples of the kind of PartStructures that might be populated are a time-stamp or the Agent setting the data.

isRepeatable (line 211)

Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.

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

boolean isRepeatable ()

Redefined in descendants as:

DimensionsPartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
FileDataPartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
FileNamePartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
FileSizePartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
MimeTypePartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
ThumbnailDataPartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
ThumbnailMimeTypePartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.
HarmoniPartStructure::isRepeatable() : Return true if this PartStructure is repeatable; false otherwise. This is determined by the implementation.

updateDisplayName (line 47)

Update the display name for this 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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefined in descendants as:

HarmoniPartStructure::updateDisplayName() : Update the display name for this PartStructure.

validatePart (line 289)

Validate a Part against its PartStructure. Return true if valid; false

otherwise. The status of the Asset holding this Record is not changed through this method. The implementation may throw an Exception for any validation failures and use the Exception's message to identify specific causes.

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

boolean validatePart (mixed $part, object Part $part )

object Part $part

Redefined in descendants as:

DimensionsPartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
FileDataPartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
FileNamePartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
FileSizePartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
MimeTypePartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
ThumbnailDataPartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
ThumbnailMimeTypePartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false
HarmoniPartStructure::validatePart() : Validate a Part against its PartStructure. Return true if valid; false

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