Interface RelationshipEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RelationshipEnablerQuerySession
public interface RelationshipEnablerSearchSession extends RelationshipEnablerQuerySession

This session provides methods for searching among RelationshipEnabler objects. The search query is constructed using the RelationshipEnableryQuery .

getRelationshipEnablersByQuery() is the basic search method and returns a list of RelationshipEnablers . A more advanced search may be performed with getRelationshipEnablersBySearch() . It accepts a RelationshipEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRelationshipEnablersBySearch() returns a RelationshipEnablerSearchResults that can be used to access the resulting RelationshipEnablerList or be used to perform a search within the result set through RelationshipEnablerSearch .

This session defines views that offer differing behaviors for searching.

  • federated relationship view: searches include relationship enablers in relationships of which this relationship is an ancestor in the relationship hierarchy
  • isolated relationship view: searches are restricted to relationship enablers in this relationship
RelationshipEnablers may have a query record indicated by their respective record types. The query record is accessed via the RelationshipEnablerQuery .

  • Method Details

    • getRelationshipEnablerSearch

      RelationshipEnablerSearch getRelationshipEnablerSearch()
      Gets a relationship enabler search.
      Returns:
      the relationship enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablerSearchOrder

      RelationshipEnablerSearchOrder getRelationshipEnablerSearchOrder()
      Gets a relationship enabler search order. The RelationshipEnablerSearchOrder is supplied to a RelationshipEnablerSearch to specify the ordering of results.
      Returns:
      the relationship enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablersBySearch

      RelationshipEnablerSearchResults getRelationshipEnablersBySearch(RelationshipEnablerQuery relationshipEnablerQuery, RelationshipEnablerSearch relationshipEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      relationshipEnablerQuery - the relationship enabler query
      relationshipEnablerSearch - the relationship enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - relationshipEnablerQuery or relationshipEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - relationshipEnablerQuery or relationshipEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablerQueryFromInspector

      RelationshipEnablerQuery getRelationshipEnablerQueryFromInspector(RelationshipEnablerQueryInspector relationshipEnablerQueryInspector)
      Gets a relationship enabler query from an inspector. The inspector is available from a RelationshipEnablerSearchResults .
      Parameters:
      relationshipEnablerQueryInspector - a relationship enabler query inspector
      Returns:
      the relationship enabler query
      Throws:
      NullArgumentException - relationshipEnablerQueryInspector is null
      UnsupportedException - relationshipEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.