Interface ProfileEntryEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProfileEntryEnablerSearchSession
public interface ProfileEntryEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated profile view: searches include profile entry enablers in profiles of which this profile is an ancestor in the profile hierarchy
  • isolated profile view: searches are restricted to profile entry enablers in this profile

Profile entry enablers may have a profile entry enabler query record indicated by their respective record types. The profile entry enabler query record is accessed via the ProfileEntryEnablerQuery.

  • Method Details

    • getProfileId

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

    • getProfile

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

    • canSearchProfileEntryEnablers

      boolean canSearchProfileEntryEnablers()
      Tests if this user can perform ProfileEntryEnabler 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.

    • useFederatedProfileView

      void useFederatedProfileView()
      Federates the view for methods in this session. A federated view will include profile entry enablers in profiles which are children of this broker in the profile hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedProfileView

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

    • getProfileEntryEnablerQuery

      ProfileEntryEnablerQuery getProfileEntryEnablerQuery()
      Gets a profile entry enabler query.
      Returns:
      the profile entry enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablersByQuery

      ProfileEntryEnablerList getProfileEntryEnablersByQuery(ProfileEntryEnablerQuery profileEntryEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ProfileEntryEnablers matching the given profile entry enabler query.
      Parameters:
      profileEntryEnablerQuery - the profile entry enabler query
      Returns:
      the returned ProfileEntryEnablerList
      Throws:
      NullArgumentException - profileEntryEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - profileEntryEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.