Interface BudgetEntrySmartBusinessSession

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

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

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

  • 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.

    • getBudgetEntryQuery

      BudgetEntryQuery getBudgetEntryQuery()
      Gets a budget entry query.
      Returns:
      the budget entry query
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntrySearchOrder

      BudgetEntrySearchOrder getBudgetEntrySearchOrder()
      Gets a budget entry search order.
      Returns:
      the budget entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyBudgetEntryQuery

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

    • inspectBudgetEntryQuery

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

    • applyBudgetEntrySequencing

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

    • getBudgetEntryQueryFromInspector

      BudgetEntryQuery getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)
      Gets a budget entry query from an inspector.
      Parameters:
      budgetEntryQueryInspector - a query inspector
      Returns:
      the budget entry query
      Throws:
      NullArgumentException - budgetEntryQueryInspector is null
      UnsupportedException - budgetEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.