Docs For Class RecordStructure

Class RecordStructure

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

Direct descendents

Class	Description
HarmoniFileRecordStructure	Each Asset has one of the AssetType supported by the Repository. There are
HarmoniRecordStructure	Each Asset has one of the AssetType supported by the Repository. There are

Method Summary

string getDescription ()

string getDisplayName ()

string getFormat ()

object Id getId ()

object PartStructureIterator getPartStructures ()

string getSchema ()

object Type getType ()

boolean isRepeatable ()

void updateDisplayName (mixed $displayName, string $displayName )

boolean validateRecord (mixed $record, object Record $record )

Methods

getDescription (line 91)

Get the description for this RecordStructure.

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:

HarmoniFileRecordStructure::getDescription() : Get the description for this RecordStructure.
HarmoniRecordStructure::getDescription() : Get the description for this RecordStructure.

getDisplayName (line 68)

Get the display name for this RecordStructure.

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:

HarmoniFileRecordStructure::getDisplayName() : Get the display name for this RecordStructure.
RemoteFileRecordStructure::getDisplayName() : Get the display name for this RecordStructure.
HarmoniRecordStructure::getDisplayName() : Get the display name for this RecordStructure.

getFormat (line 185)

Get the format for this RecordStructure. The format is defined by the implementation, e.g. XML.

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

Redefined in descendants as:

HarmoniFileRecordStructure::getFormat() : Get the format for this RecordStructure. The format is defined by the implementation, e.g. XML.
HarmoniRecordStructure::getFormat() : Get the format for this RecordStructure. The format is defined by the implementation, e.g. XML.

getId (line 114)

Get the unique Id for this RecordStructure.

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:

HarmoniFileRecordStructure::getId() : Get the unique Id for this RecordStructure.
RemoteFileRecordStructure::getId() : Get the unique Id for this RecordStructure.
HarmoniRecordStructure::getId() : Get the unique Id for this RecordStructure.

getPartStructures (line 233)

Get all the PartStructures in the RecordStructure. 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:

HarmoniFileRecordStructure::getPartStructures() : Get all the PartStructures in the RecordStructure. Iterators return a set, one at a time.
HarmoniRecordStructure::getPartStructures() : Get all the PartStructures in the RecordStructure. Iterators return a set, one at a time.

getSchema (line 161)

Get the schema for this RecordStructure. The schema is defined by the implementation, e.g. Dublin Core.

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

Redefined in descendants as:

HarmoniFileRecordStructure::getSchema() : Get the schema for this RecordStructure. The schema is defined by the implementation, e.g. Dublin Core.
HarmoniRecordStructure::getSchema() : Get the schema for this RecordStructure. The schema is defined by the implementation, e.g. Dublin Core.

getType (line 137)

Get the Type for this RecordStructure.

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:

HarmoniFileRecordStructure::getType() : Get the Type for this RecordStructure.
HarmoniRecordStructure::getType() : Get the Type for this RecordStructure.

isRepeatable (line 209)

Return true if this RecordStructure 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:

HarmoniRecordStructure::isRepeatable() : Return true if this RecordStructure is repeatable; false otherwise.

updateDisplayName (line 45)

Update the display name for this RecordStructure.

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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefined in descendants as:

HarmoniRecordStructure::updateDisplayName() : Update the display name for this RecordStructure.

validateRecord (line 264)

Validate a Record against its RecordStructure. 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 validateRecord (mixed $record, object Record $record )

object Record $record

Redefined in descendants as:

HarmoniFileRecordStructure::validateRecord() : Validate a Record against its RecordStructure. Return true if valid;
HarmoniRecordStructure::validateRecord() : Validate a Record against its RecordStructure. Return true if valid;

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