Interface BudgetQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
BudgetSearchSession
public interface BudgetQuerySession extends OsidSession

This session provides methods for searching among Budgets . The search query is constructed using the BudgetQuery .

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include budgets in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to budgets in this business

Budgets may have a query record indicated by their respective query record types. The query record is accessed via the BudgetQuery .

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

    • canSearchBudgets

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

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include budgets in business which are children of this business in the business hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBusinessView

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

    • getBudgetQuery

      BudgetQuery getBudgetQuery()
      Gets a budget query.
      Returns:
      the budget query.
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetsByQuery

      BudgetList getBudgetsByQuery(BudgetQuery budgetQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Budgets matching the given budget query.
      Parameters:
      budgetQuery - the budget query
      Returns:
      the returned BudgetList
      Throws:
      NullArgumentException - budgetQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - budgetQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.