Interface RelationshipSmartFamilySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RelationshipSmartFamilySession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A RelationshipQuery can be retrieved from this session and mapped to this Family to create a virtual collection of Relationships . The entries may be sequenced using the RelationshipSearchOrder from this session.

This Family has a default query that matches any relationship and a default search order that specifies no sequencing. The queries may be examined using a RelationshipQueryInspector . The query may be modified by converting the inspector back to a 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.

    • canManageSmartFamilies

      boolean canManageSmartFamilies()
      Tests if this user can manage smart families. 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 smart operations.
      Returns:
      false if smart family 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.

    • getRelationshipSearchOrder

      RelationshipSearchOrder getRelationshipSearchOrder()
      Gets a relationship search order.
      Returns:
      the relationship search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRelationshipQuery

      void applyRelationshipQuery(RelationshipQuery relationshipQuery) throws OperationFailedException, PermissionDeniedException
      Applies a relationship query to this family.
      Parameters:
      relationshipQuery - the relationship query
      Throws:
      NullArgumentException - relationshipQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - relationshipQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectRelationshipQuery

      RelationshipQueryInspector inspectRelationshipQuery() throws OperationFailedException, PermissionDeniedException
      Gets a relationship query inspector for this family.
      Returns:
      the relationship query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyRelationshipSequencing

      void applyRelationshipSequencing(RelationshipSearchOrder relationshipSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a relationship search order to this family.
      Parameters:
      relationshipSearchOrder - the relationship search order
      Throws:
      NullArgumentException - relationshipSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - relationshipSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipQueryFromInspector

      RelationshipQuery getRelationshipQueryFromInspector(RelationshipQueryInspector relationshipQueryInspector)
      Gets a relationship query from an inspector.
      Parameters:
      relationshipQueryInspector - a relationship query inspector
      Returns:
      the relationship query
      Throws:
      NullArgumentException - relatinshipQueryInspector is null
      UnsupportedException - relationshipQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.