Interface ProfileEntryEnablerSmartProfileSession

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

This session manages queries and sequencing to create "smart" dynamic profiles. A ProfileEntryEnablerQuery can be retrieved from this session and mapped to this Profile to create a virtual collection of profile entry enablers. The profile entry enablers may be sequenced using the ProfileEntryEnablerSearchOrder from this session.

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

    • canManageSmartProfiles

      boolean canManageSmartProfiles()
      Tests if this user can manage smart profiles. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart profile management is not authorized, true otherwise
      Compliance:
      mandatory - This method 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.

    • getProfileEntryEnablerSearchOrder

      ProfileEntryEnablerSearchOrder getProfileEntryEnablerSearchOrder()
      Gets a profile entry enabler search order.
      Returns:
      the profile entry enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProfileEntryEnablerQuery

      void applyProfileEntryEnablerQuery(ProfileEntryEnablerQuery profileEntryEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a profile entry enabler query to this profile.
      Parameters:
      profileEntryEnablerQuery - the profile entry enabler query
      Throws:
      NullArgumentException - profileEntryEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - profileEntryEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectProfileEntryEnablerQuery

      ProfileEntryEnablerQueryInspector inspectProfileEntryEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a profile entry enabler query inspector for this profile.
      Returns:
      the profile entry enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyProfileEntryEnablerSequencing

      void applyProfileEntryEnablerSequencing(ProfileEntryEnablerSearchOrder profileEntryEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a profile entry enabler search order to this profile.
      Parameters:
      profileEntryEnablerSearchOrder - the profile entry enabler search order
      Throws:
      NullArgumentException - profileEntryEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - profileEntryEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablerQueryFromInspector

      ProfileEntryEnablerQuery getProfileEntryEnablerQueryFromInspector(ProfileEntryEnablerQueryInspector profileEntryEnablerQueryInspector)
      Gets a profile entry enabler query from an inspector.
      Parameters:
      profileEntryEnablerQueryInspector - a profile entry enabler query inspector
      Returns:
      the profile entry enabler query
      Throws:
      NullArgumentException - profileEntryEnablerQueryInspector is null
      UnsupportedException - profileEntryEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.