Source for file TopicName.interface.php

<?php
/**
 * @package org.phptmapi.core
*/
require_once('ScopedObject.interface.php');
require_once('TypedObject.interface.php');
/**
 * Interface TopicNameInterface: Represents the topic map topicname construct. In XTM 1.0, this construct is represented by the <baseName> element. In XTM 2.0, this construct is represented by the <name> element.
 *
 * @author Johannes Schmidt - t8d <kontakt@t8d.de>
*/
interface TopicNameInterface extends ScopedObjectInterface, TypedObjectInterface{    
    /**
    * createVariant: Creates a variant of this topic name with the specified resource data string and scopes.
    * @param string $value The inline data string for the variant. Pass null for no string.
    * @param string $datatype An XML Schema Datatype.
    * @param array $scope The scope for the variant to be created. Must be an array of TopicInterface objects.
    * @access public
    * @return object VariantInterface 
    */
    public function createVariant($value, $datatype, $scope);
 
    /**
    * getReifier: Returns the topic that reifies this topic name.
    * @access public
    * @return object TopicInterface 
    */
    public function getReifier();
    
    /**
    * setReifier: Sets the reifiying topic of this topic 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);
    
    /**
    * getTopic: Returns the topic which contains this topic name.
    * @access public
    * @return object TopicInterface 
    */
    public function getTopic();
    
    /**
    * getValue: Returns the name string of the topic name.
    * @access public
    * @return string OR null
    */
    public function getValue();
    
    /**
    * getVariants: Returns the VariantInterface instances defined for this topic name. The return value may be an empty array, but is never null.
    * @access public
    * @return array 
    */
    public function getVariants();
    
    /**
    * setValue: Define the name string for this topic name. A new value will replace any existing value. A null value indicates that there is no name string for this topic name.
    * @param string $value 
    * @access public
    * @return void 
    * @throws MergeException if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason.
    *  <code>
    *     public function setValue($value){
    *         throw new MergeException('Exception in '.__method__);
    *     }
    *  </code>
    */
    public function setValue($value);
}
?>