Interface AssociationRolesIndexInterface

Description
Description | Methods (details)

Interface AssociationRolesIndexInterface: An index of the association roles in the indexed topic map.

Interface AssociationRolesIndexInterface: An index of the association roles in the indexed topic map. This index provides methods to retrieve AssociationRoleInterface instances by their type and to retrieve the array of all topics which define the type of one or more AssociationRoleInterface instances in the indexed topic map.

Located in /org.phptmapi.index.core/AssociationRolesIndex.interface.php (line 11) 

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --AssociationRolesIndexInterface
Method Summary
Description | Methods (details)
array getAssociationRolesByType (object TopicInterface $type)
array getAssociationRoleTypes ()
Methods
Description | Methods (details)
getAssociationRolesByType (line 25)

getAssociationRolesByType: Returns all AssociationRoleInterface instances typed by the topic type in the indexed topic map.

getAssociationRolesByType: Returns all AssociationRoleInterface instances typed by the topic type in the indexed topic map. The return value may be an empty array but must never be null.

  • return: An array of AssociationRoleInterface instances.
  • access: public
array getAssociationRolesByType (object TopicInterface $type)
  • object TopicInterface $type: The type of the association roles to be returned. If $type is null an array containing all untyped AssociationRoleInterface objects will be returned.
getAssociationRoleTypes (line 17)

getAssociationRoleTypes: Returns all TopicInterface instances used to type AssociationRoleInterface instances in the indexed topic map.

getAssociationRoleTypes: Returns all TopicInterface instances used to type AssociationRoleInterface instances in the indexed topic map. The return value may be an empty array but must never be null.

  • return: An array of TopicInterface instances.
  • access: public
array getAssociationRoleTypes ()

Inherited Methods

Inherited From IndexInterface

IndexInterface::close()
IndexInterface::getFlags()
IndexInterface::isAutoUpdated()
IndexInterface::isOpen()
IndexInterface::open()
IndexInterface::reindex()

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()

Documentation generated on Fri, 30 Jun 2006 13:06:49 +0200 by phpDocumentor 1.3.0RC4