Interface EntrySmartBusinessSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An EntryQuery can be retrieved from this session and mapped to this Business to create a virtual collection of Entries . The entries may be sequenced using the EntrySearchOrder from this session.

This Business has a default query that matches any entry and a default search order that specifies no sequencing. The queries may be examined using an EntryQueryInspector . The query may be modified by converting the inspector back to an EntryQuery .

  • Method Details

    • getBusinessId

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

    • getBusiness

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

    • canManageSmartBusinesses

      boolean canManageSmartBusinesses()
      Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. 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 business management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEntryQuery

      EntryQuery getEntryQuery()
      Gets an entry query.
      Returns:
      the entry query
      Compliance:
      mandatory - This method must be implemented.

    • getEntrySearchOrder

      EntrySearchOrder getEntrySearchOrder()
      Gets an entry search order.
      Returns:
      the entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyEntryQuery

      void applyEntryQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
      Applies an entry query to this business.
      Parameters:
      entryQuery - the entry query
      Throws:
      NullArgumentException - entryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - entryQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectEntryQuery

      EntryQueryInspector inspectEntryQuery() throws OperationFailedException, PermissionDeniedException
      Gets an entry query inspector for this business.
      Returns:
      the entry query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyEntrySequencing

      void applyEntrySequencing(EntrySearchOrder entrySearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an entry search order to this business.
      Parameters:
      entrySearchOrder - the entry search order
      Throws:
      NullArgumentException - entrySearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - entrySearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getEntryQueryFromInspector

      EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
      Gets an entry query from an inspector.
      Parameters:
      entryQueryInspector - a query inspector
      Returns:
      the entry query
      Throws:
      NullArgumentException - entryQueryInspector is null
      UnsupportedException - entryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.