Interface RelationshipQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RelationshipSearchSession
public interface RelationshipQuerySession extends OsidSession

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

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

  • Method Details

    • getFamilyId

      Id getFamilyId()
      Gets the Family Id associated with this session.
      Returns:
      the Family Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getFamily

      Family getFamily() throws OperationFailedException, PermissionDeniedException
      Gets the Family associated with this session.
      Returns:
      the family
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedFamilyView

      void useFederatedFamilyView()
      Federates the view for methods in this session. A federated view will include relationships in families which are children of this family in the family hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFamilyView

      void useIsolatedFamilyView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this family only.
      Compliance:
      mandatory - This method is must be implemented.

    • canSearchRelationships

      boolean canSearchRelationships()
      Tests if this user can perform Relationship searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipQuery

      RelationshipQuery getRelationshipQuery()
      Gets a relationship query.
      Returns:
      the relationship query
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipsByQuery

      RelationshipList getRelationshipsByQuery(RelationshipQuery relationshipQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Relationships matching the given relationship query.
      Parameters:
      relationshipQuery - the relationship query
      Returns:
      the returned RelationshipList
      Throws:
      NullArgumentException - relationshipQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - relationshipQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.