Interface Association

Description

Represents an association item.

Represents an association item. See http://www.isotopicmaps.org/sam/sam-model/#sect-association. Inherited method getParent() from Construct returns the TopicMap to which this association belongs.

Located in /core/Association.interface.php (line 29)

Construct
   |
   --Reifiable
      |
      --Association
Method Summary
Role createRole (Topic $type, Topic $player)
array getRoles ([Topic $type = null])
array getRoleTypes ()
Methods
createRole (line 52)

Creates a new Role representing a role in this association.

Creates a new Role representing a role in this association.

  • return: A newly created association role.
  • throws: ModelConstraintException If either the type or the player does not belong to the parent topic map.
  • access: public
Role createRole (Topic $type, Topic $player)
  • Topic $type: The role type.
  • Topic $player: The role player.
getRoles (line 41)

Returns the Roles participating in this association.

Returns the Roles participating in this association. If type is not null all roles with the specified type are returned. The return value may be an empty array but must never be null.

  • return: An array containing a set of Roles.
  • access: public
array getRoles ([Topic $type = null])
  • Topic $type: The type of the Role instances to be returned. Default null.
getRoleTypes (line 60)

Returns the role types participating in this association.

Returns the role types participating in this association. The return value may be an empty array but must never be null.

  • return: An array containing a set of Topics representing the role types.
  • access: public
array getRoleTypes ()

Inherited Methods

Inherited From Reifiable

Reifiable::getReifier()
Reifiable::setReifier()

Inherited From Construct

Construct::addItemIdentifier()
Construct::equals()
Construct::getId()
Construct::getItemIdentifiers()
Construct::getParent()
Construct::getTopicMap()
Construct::hashCode()
Construct::remove()
Construct::removeItemIdentifier()

Documentation generated on Sat, 15 Jan 2011 20:02:25 +0100 by phpDocumentor 1.4.1