Documentation is available at Occurrence.interface.php
- <?php
- /**
- * @package org.phptmapi.core
- */
- require_once('ScopedObject.interface.php');
- require_once('TypedObject.interface.php');
- /**
- * Interface OccurrenceInterface: Represents the topic map occurrence construct. An occurrence contains a value data string. The XML Schema Datatype specifies the data string for being interpreted as a reference to an external resource for example.
- *
- * @author Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>
- */
- interface OccurrenceInterface extends ScopedObjectInterface, TypedObjectInterface{
- /**
- * getReifier: Returns the topic that reifies this occurrence.
- * @access public
- * @return object TopicInterface
- */
- public function getReifier();
- /**
- * setReifier: Sets the reifiying topic of this variant name.
- * @access public
- * @param object TopicInterface $reifier or null if the reifier should be set to null.
- * @return void
- * @throws ModelConstraintException if the topic already reifies another object.
- * <code>
- * public function setReifier($reifier){
- * throw new ModelConstraintException('Exception in '.__method__);
- * }
- * </code>
- */
- public function setReifier($reifier);
- /**
- * getTopic: Returns the topic to which this occurrence belongs.
- * @access public
- * @return TopicInterface The TopicInterface object which contains this occurrence.
- */
- public function getTopic();
- /**
- * getValue: Returns the data string associated with this occurrence.
- * @access public
- * @return string
- */
- public function getValue();
- /**
- * setValue: Sets the value data string for this occurrence. This method will overwrite any existing value data string.
- * @access public
- * @param string $value
- * @param string $datatype An XML Schema Datatype.
- * @return void
- */
- public function setValue($value, $datatype);
- /**
- * getDatatype: Returns the datatype of the occurrence's resource data.
- * @access public
- * @return string
- */
- public function getDatatype();
- }
- ?>
Documentation generated on Fri, 30 Jun 2006 13:06:56 +0200 by phpDocumentor 1.3.0RC4