Class DimensionsPartStructure

Description
Description | Vars (details) | Methods (details)

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: DimensionsPartStructure.class.php,v 1.7 2007/09/04 20:25:44 adamfranco Exp $
  • license: GNU General Public License
  • copyright: Copyright &copy;2005, Middlebury College

Located in /harmoni/core/oki2/repository/File/Fields/DimensionsPartStructure.class.php (line 26) 

PartStructure
   |
   --DimensionsPartStructure
Variable Summary
Description | Vars (details) | Methods (details)
mixed $_idString
mixed $_partStructure
Method Summary
Description | Vars (details) | Methods (details)
DimensionsPartStructure DimensionsPartStructure (mixed $partStructure, mixed $idString)
void addAuthoritativeValue (object $value)
void addAuthoritativeValueAsString (string $valueString)
object createValueObjectFromString (string $valueString)
object ObjectIterator getAuthoritativeValues ()
string getDescription ()
string getDisplayName ()
object Id getId ()
object PartStructureIterator getPartStructure ()
object RecordStructure getRecordStructure ()
object Type getType ()
boolean isAuthoritativeValue (object $value)
boolean isMandatory ()
boolean isPopulatedByRepository ()
boolean isRepeatable ()
void removeAuthoritativeValue (object $value)
boolean validatePart (mixed $part, object Part $part )
Variables
Description | Vars (details) | Methods (details)
mixed $_idString (line 31)
mixed $_partStructure (line 30)
Methods
Description | Vars (details) Methods (details)
Constructor DimensionsPartStructure (line 33)
DimensionsPartStructure DimensionsPartStructure (mixed $partStructure, mixed $idString)
addAuthoritativeValue (line 352)

Add an authoritative value

WARNING: NOT in OSID

  • since: 4/25/06
  • access: public
void addAuthoritativeValue (object $value)
  • object $value
addAuthoritativeValueAsString (line 367)

Add an authoritative value

WARNING: NOT in OSID

  • since: 4/25/06
  • access: public
void addAuthoritativeValueAsString (string $valueString)
  • string $valueString
createValueObjectFromString (line 379)

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

Answer the authoritative values for this part.

WARNING: NOT in OSID

  • since: 4/25/06
  • access: public
object ObjectIterator getAuthoritativeValues ()
getDescription (line 80)

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

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

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.
getPartStructure (line 155)

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 getPartStructure ()
getRecordStructure (line 252)

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.
getType (line 103)

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

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

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

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

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

Remove an authoritative value.

WARNING: NOT in OSID

  • since: 4/25/06
  • access: public
void removeAuthoritativeValue (object $value)
  • object $value
validatePart (line 283)

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

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:22:44 -0400 by phpDocumentor 1.3.0RC3