Class FileUrlPart

Description

A Part for storing the file's URL

  • version: $Id: FileUrlPart.class.php,v 1.3 2007/09/11 17:40:57 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College
  • since: 12/5/06

Located in /harmoni/core/oki2/repository/File/Fields/FileUrlPart.class.php (line 23)

Part
   |
   --FileUrlPart
Variable Summary
mixed $_recordId
mixed $_value
Method Summary
FileUrlPart FileUrlPart (mixed $partStructure, mixed $recordId, mixed $configuration, mixed $asset)
object Part createPart (object Id $partStructureId, object mixed $value)
void deletePart (mixed $partId, object Id $partId )
object Id getId ()
object PartIterator getParts ()
object PartStructure getPartStructure ()
object mixed getValue ()
void updateValue (object mixed $value)
void _updateValue (string $value)
Variables
mixed $_partStructure (line 28)
mixed $_recordId (line 27)
mixed $_value (line 29)
Methods
Constructor FileUrlPart (line 31)
FileUrlPart FileUrlPart (mixed $partStructure, mixed $recordId, mixed $configuration, mixed $asset)
createPart (line 94)

Create a Part. Records are composed of Parts. Parts can also contain other Parts. Each Record is associated with a specific RecordStructure and each Part is associated with a specific 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, UNKNOWN_ID
object Part createPart (object Id $partStructureId, object mixed $value)
  • object Id $partStructureId
  • object mixed $value: (original type: java.io.Serializable)

Redefinition of:
Part::createPart()
Create a Part. Records are composed of Parts. Parts can also contain other Parts. Each Record is associated with a specific RecordStructure and each Part is associated with a specific PartStructure.
deletePart (line 121)

Delete a Part and all its Parts.

  • 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, UNKNOWN_ID
void deletePart (mixed $partId, object Id $partId )
  • object Id $partId

Redefinition of:
Part::deletePart()
Delete a Part and all its Parts.
getId (line 62)

Get the unique Id for this Part.

  • 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:
Part::getId()
Get the unique Id for this Part.
getParts (line 145)

Get all the Parts in this Part. 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 PartIterator getParts ()

Redefinition of:
Part::getParts()
Get all the Parts in this Part. Iterators return a set, one at a time.
getPartStructure (line 274)

Get the PartStructure associated with this Part.

  • 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 PartStructure getPartStructure ()

Redefinition of:
Part::getPartStructure()
Get the PartStructure associated with this Part.
getValue (line 169)

Get the value for this Part.

  • return: (original type: java.io.Serializable)
  • 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 mixed getValue ()

Redefinition of:
Part::getValue()
Get the value for this Part.
updateValue (line 215)

Update the value for this Part.

  • 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 updateValue (object mixed $value)
  • object mixed $value: (original type: java.io.Serializable)

Redefinition of:
Part::updateValue()
Update the value for this Part.
_updateValue (line 286)

Allow the file record to update the fetch from its own queries

  • since: 11/17/05
  • access: private
void _updateValue (string $value)
  • string $value

Inherited Methods

Inherited From Part

Part::createPart()
Part::deletePart()
Part::getDisplayName()
Part::getId()
Part::getParts()
Part::getPartStructure()
Part::getValue()
Part::updateDisplayName()
Part::updateValue()

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