Documentation is available at Variant.interface.php
- <?php
- /**
- * @package org.phptmapi.core
- */
- require_once('ScopedObject.interface.php');
- /**
- * Interface VariantInterface: Represents the topic map variant name construct. A variant name is qualified by zero or more parameters, each of which is a topic. This class uses the ScopedObjectInterface to manage the parameters. When implementing the VariantInterface remember that VARIANT is a native PHP class.
- *
- * @author Johannes Schmidt - t8d <kontakt@t8d.de>
- */
- interface VariantInterface extends ScopedObjectInterface{
- /**
- * getReifier: Returns the topic that reifies this variant name.
- * @access public
- * @return object TopicInterface
- */
- public function getReifier();
- /**
- * setReifier: Sets the reifiying topic of this variant name.
- * @param object TopicInterface $reifier or null if the reifier should be set to null.
- * @access public
- * @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);
- /**
- * getTopicName: Returns the topic name to which this variant belongs.
- * @access public
- * @return object TopicNameInterface
- */
- public function getTopicName();
- /**
- * getValue: Returns the data string associated with this variant.
- * @access public
- * @return string
- */
- public function getValue();
- /**
- * setValue: Sets the resource data string for this variant. This method will overwrite any existing value data string and will set the value of the resource property to null.
- * @param string $value
- * @param string $datatype An XML Schema Datatype.
- * @access public
- * @return void
- */
- public function setValue($value, $datatype);
- /**
- * getDatatype: Returns the datatype of the variant's resource data.
- * @access public
- * @return string
- */
- public function getDatatype();
- }
- ?>
Documentation generated on Fri, 30 Jun 2006 13:07:19 +0200 by phpDocumentor 1.3.0RC4