Interface AvailabilityEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AvailabilityEnablerSearchSession
public interface AvailabilityEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include availability enablers in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to availability enablers in this foundry

An availability enabler may have an availability enabler query record indicated by their respective record types. The availability enabler query record is accessed via the AvailabilityEnablerQuery .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canSearchAvailabilityEnablers

      boolean canSearchAvailabilityEnablers()
      Tests if this user can perform AvailabilityEnabler lookups. 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include availability enabler in foundries which are children of this availability in the foundry hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFoundryView

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

    • getAvailabilityEnablerQuery

      AvailabilityEnablerQuery getAvailabilityEnablerQuery()
      Gets an availability enabler query.
      Returns:
      the availability enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAvailabilityEnablersByQuery

      AvailabilityEnablerList getAvailabilityEnablersByQuery(AvailabilityEnablerQuery availabilityEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AvailabilityEnablers matching the given availability enabler query.
      Parameters:
      availabilityEnablerQuery - the availability enabler query
      Returns:
      the returned AvailabilityEnablerList
      Throws:
      NullArgumentException - availabilityEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - availabilityEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.