Docs For Class AssociationInterface

Description

Interface AssociationInterface: Represents the topic map association construct.

author: Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>

Located in /org.phptmapi.core/Association.interface.php (line 12)

TopicMapObjectInterface
   |
   --ScopedObjectInterface
      |
      --AssociationInterface

Method Summary

object AssociationRoleInterface createAssociationRole (object TopicInterface $player, object TopicInterface $type)

array getAssociationRoles ()

object TopicInterface getReifier ()

void setReifier (object TopicInterface $reifier)

Methods

createAssociationRole (line 20)

createAssociationRole: Creates a new AssociationRoleInterface representing a role in this association.

return: The newly created association role.
access: public

object AssociationRoleInterface createAssociationRole (object TopicInterface $player, object TopicInterface $type)

object TopicInterface $player: The topic playing the role or null if there is no player of this role.
object TopicInterface $type: The topic defining the role of the new association role, or null if the role is untyped.

getAssociationRoles (line 27)

getAssociationRoles: Returns the AssociationRoleInterface objects representing all of the roles in this association.

access: public

array getAssociationRoles ()

getReifier (line 34)

getReifier: Returns the TopicInterface that reifies this association.

return: A TopicInterface instance or null if the association is not reified.
access: public

object TopicInterface getReifier ()

setReifier (line 48)

setReifier: Sets the reifiying topic of this association.

access: public

throws: ModelConstraintException if the topic already reifies another object.

    public function setReifier($reifier){
        throw new ModelConstraintException('Exception in '.__method__);
    }

void setReifier (object TopicInterface $reifier)

object TopicInterface $reifier: or null if the reifier should be set to null.

Inherited Methods

Inherited From ScopedObjectInterface

ScopedObjectInterface::addScopingTopic()
ScopedObjectInterface::getScope()
ScopedObjectInterface::removeScopingTopic()

Inherited From TopicMapObjectInterface

TopicMapObjectInterface::addItemIdentifier()
TopicMapObjectInterface::getItemIdentifiers()
TopicMapObjectInterface::getObjectId()
TopicMapObjectInterface::getParent()
TopicMapObjectInterface::getTopicMap()
TopicMapObjectInterface::remove()
TopicMapObjectInterface::removeItemIdentifier()