Docs For Class HarmoniPartStructure

Class HarmoniPartStructure

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: HarmoniPartStructure.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/HarmoniPartStructure.class.php (line 26)

PartStructure
   |
   --HarmoniPartStructure

Variable Summary

mixed $_recordStructure

mixed $_schemaField

Method Summary

HarmoniPartStructure HarmoniPartStructure (mixed $recordStructure, mixed $schemaField, mixed $repositoryId)

void addAuthoritativeValue (object $value)

void addAuthoritativeValueAsString (string $valueString)

object createValueObjectFromString (string $valueString)

object ObjectIterator getAuthoritativeValues ()

string getDescription ()

string getDisplayName ()

object Id getId ()

object PartStructureIterator getPartStructures ()

object RecordStructure getRecordStructure ()

object Id getRepositoryId ()

object Type getType ()

boolean isAuthoritativeValue (object $value)

boolean isMandatory ()

boolean isPopulatedByRepository ()

boolean isRepeatable ()

void removeAuthoritativeValue (object $value)

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateIsMandatory (mixed $isMandatory, boolean $isMandatory )

void updateIsRepeatable (mixed $isRepeatable, boolean $isRepeatable )

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

void _loadAuthoritativeValueStrings ()

Variables

mixed $_recordStructure (line 31)

mixed $_schemaField (line 30)

Methods

Constructor HarmoniPartStructure (line 33)

HarmoniPartStructure HarmoniPartStructure (mixed $recordStructure, mixed $schemaField, mixed $repositoryId)

addAuthoritativeValue (line 514)

Add an authoritative value

WARNING: NOT in OSID

since: 4/25/06
access: public

void addAuthoritativeValue (object $value)

object $value

addAuthoritativeValueAsString (line 549)

Add an authoritative value

WARNING: NOT in OSID

since: 4/25/06
access: public

void addAuthoritativeValueAsString (string $valueString)

string $valueString

createValueObjectFromString (line 563)

Answer the Primative object appropriate for this part, whose value is represented by the input string.

since: 4/27/06
access: public

object createValueObjectFromString (string $valueString)

string $valueString

getAuthoritativeValues (line 436)

Answer the authoritative values for this part.

WARNING: NOT in OSID

since: 4/25/06
access: public

object ObjectIterator getAuthoritativeValues ()

getDescription (line 111)

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

Redefinition of:

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

getDisplayName (line 59)

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

Redefinition of:

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

getId (line 193)

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

Redefinition of:

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

getPartStructures (line 220)

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

Redefinition of:

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

getRecordStructure (line 379)

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

Redefinition of:

PartStructure::getRecordStructure(): Get the RecordStructure associated with this PartStructure.

getRepositoryId (line 581)

Answer the Id of the repository from whence this PartStructure came.

WARNING: NOT in OSID

since: 6/8/06
access: public

object Id getRepositoryId ()

getType (line 165)

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

Redefinition of:

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

isAuthoritativeValue (line 465)

Answer true if the value pass is authoritative.

WARNING: NOT in OSID

since: 4/25/06
access: public

boolean isAuthoritativeValue (object $value)

object $value

isMandatory (line 270)

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

Redefinition of:

PartStructure::isMandatory(): Return true if this PartStructure is mandatory; false otherwise.

isPopulatedByRepository (line 247)

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

Redefinition of:

PartStructure::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 324)

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

Redefinition of:

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

removeAuthoritativeValue (line 480)

Remove an authoritative value.

WARNING: NOT in OSID

since: 4/25/06
access: public

void removeAuthoritativeValue (object $value)

object $value

updateDescription (line 139)

Update the description for this PartStructure.

WARNING: NOT IN OSID

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 updateDescription (mixed $description, string $description )

string $description

updateDisplayName (line 85)

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

Redefinition of:

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

updateIsMandatory (line 297)

Update the mandatory flag for this PartStructure.

WARNING: NOT IN OSID

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 updateIsMandatory (mixed $isMandatory, boolean $isMandatory )

boolean $isMandatory

updateIsRepeatable (line 351)

Update the repeatable flag for this PartStructure.

WARNING: NOT IN OSID

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 updateIsRepeatable (mixed $isRepeatable, boolean $isRepeatable )

boolean $isRepeatable

validatePart (line 410)

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

Redefinition of:

PartStructure::validatePart(): Validate a Part against its PartStructure. Return true if valid; false

_loadAuthoritativeValueStrings (line 594)

Load the authoritative value list

WARNING: NOT in OSID

since: 4/25/06
access: private

void _loadAuthoritativeValueStrings ()

Inherited Methods

Inherited From PartStructure

PartStructure::getDescription()
PartStructure::getDisplayName()
PartStructure::getId()
PartStructure::getPartStructures()
PartStructure::getRecordStructure()
PartStructure::getType()
PartStructure::isMandatory()
PartStructure::isPopulatedByRepository()
PartStructure::isRepeatable()
PartStructure::updateDisplayName()
PartStructure::validatePart()

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