Interface ResourceRelationshipSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ResourceRelationshipQuerySession
public interface ResourceRelationshipSearchSession extends ResourceRelationshipQuerySession

This session provides methods for searching ResourceRelationship objects. The search query is constructed using the ResourceRelationshipQuery . The resource relationship record Type also specifies the record for the relationship query.

getResourceRelationshipsByQuery() is the basic search method and returns a list of ResourceRelationships . A more advanced search may be performed with getResourceRelationshipsBySearch() . It accepts a ResourceRelationshipSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getResourceRelationshipsBySearch() returns an ResourceRelationshipSearchResults that can be used to access the resulting ResourceRelationshipList or be used to perform a search within the result set through ResourceRelationshipSearch .

This session defines views that offer differing behaviors for searching.

  • federated bin view: searches include relationships in bins of which this bin is an ancestor in the bin hierarchy
  • isolated bin view: searches are restricted to relationships in this bin only

Relationships may have a resource relationship query record indicated by their respective record types. The resource relationship query record is accessed via the ResourceRelationshipQuery .

  • Method Details

    • getResourceRelationshipSearch

      ResourceRelationshipSearch getResourceRelationshipSearch()
      Gets a relationship search.
      Returns:
      the relationship search
      Compliance:
      mandatory - This method must be implemented.

    • getResourceRelationshipSearchOrder

      ResourceRelationshipSearchOrder getResourceRelationshipSearchOrder()
      Gets a relationship search order. The ResourceRelationshipSearchOrder is supplied to a ResourceRelationshipSearch to specify the ordering of results.
      Returns:
      the relationship search order
      Compliance:
      mandatory - This method must be implemented.

    • getResourceRelationshipsBySearch

      ResourceRelationshipSearchResults getResourceRelationshipsBySearch(ResourceRelationshipQuery resourceRelationshipQuery, ResourceRelationshipSearch resourceRelationshipSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      resourceRelationshipQuery - the resource relationship query
      resourceRelationshipSearch - the resource relationship search
      Returns:
      the returned resource relationship search results
      Throws:
      NullArgumentException - resourceRelationshipQuery or r esourceRelationshipSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - resourceRelationshipSearch or r esourceRelationshipQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getResourceRelationshipQueryFromInspector

      ResourceRelationshipQuery getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector)
      Gets a resource relationship query from an inspector. The inspector is available from a ResourceRelationshipSearchResults .
      Parameters:
      resourceRelationshipQueryInspector - a query inspector
      Returns:
      the resource relationship query
      Throws:
      NullArgumentException - resourceRelationshipQueryInspector is null
      UnsupportedException - resourceRelationshipQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.