Source for file AssociationRolesIndex.interface.php

Documentation is available at AssociationRolesIndex.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index.core
  4. */
  5. require_once('../org.phptmapi.index/Index.interface.php');
  6. /**
  7. * 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.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface AssociationRolesIndexInterface extends IndexInterface{
  12. /**
  13. * 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.
  14. * @access public
  15. * @return array An array of TopicInterface instances.
  16. */
  17. public function getAssociationRoleTypes();
  18. /**
  19. * 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.
  20. * @param 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.
  21. * @access public
  22. * @return array An array of AssociationRoleInterface instances.
  23. */
  24. public function getAssociationRolesByType($type);
  25. }
  26. ?>

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