Docs For Class HarmoniFileRecordStructure

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

Located in /harmoni/core/oki2/repository/File/FileRecordStructure.class.php (line 33)

RecordStructure
   |
   --HarmoniFileRecordStructure

Direct descendents

Class	Description
RemoteFileRecordStructure	The remote file record structure defines files who's data lives at a remote url.

Variable Summary

mixed $_partStructures

Method Summary

HarmoniFileRecordStructure HarmoniFileRecordStructure ()

string getDescription ()

string getDisplayName ()

string getFormat ()

object Id getId ()

object PartStructureIterator getPartStructure (mixed $partStructureId)

object PartStructureIterator getPartStructures ()

object TypeIterator getPartStructureTypes ()

string getSchema ()

object Type getType ()

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

Variables

mixed $_partStructures (line 37)

Methods

Constructor HarmoniFileRecordStructure (line 39)

HarmoniFileRecordStructure HarmoniFileRecordStructure ()

getDescription (line 97)

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

Redefinition of:

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

getDisplayName (line 74)

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

Redefinition of:

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

Redefined in descendants as:

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

getFormat (line 246)

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

Redefinition of:

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

getId (line 120)

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

Redefinition of:

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

Redefined in descendants as:

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

getPartStructure (line 169)

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 getPartStructure (mixed $partStructureId)

getPartStructures (line 197)

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

Redefinition of:

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

getPartStructureTypes (line 289)

Get the possible types for PartStructures.

return: The Types supported in this implementation.

object TypeIterator getPartStructureTypes ()

getSchema (line 222)

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

Redefinition of:

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

getType (line 144)

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

Redefinition of:

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

validateRecord (line 277)

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

Redefinition of:

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

Inherited Methods

Inherited From RecordStructure

RecordStructure::getDescription()
RecordStructure::getDisplayName()
RecordStructure::getFormat()
RecordStructure::getId()
RecordStructure::getPartStructures()
RecordStructure::getSchema()
RecordStructure::getType()
RecordStructure::isRepeatable()
RecordStructure::updateDisplayName()
RecordStructure::validateRecord()