Interface BudgetEntryLookupSession

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

This session provides methods for retrieving BudgetEntries .

This session defines views that offer differing behaviors when retrieving multiple budget entries.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated business view: All budget entry methods in this session operate, retrieve and pertain to budget entries defined explicitly in the current business. Using an isolated view is useful for managing BudgetEntries with the BudgetEntryAdminSession .
  • federated business view: All budget entry methods in this session operate, retrieve and pertain to all budget entries defined in this business and any other budget entries implicitly available in this business through business inheritence.
  • effective budget entry view: All budget entry lookup methods return budget entries where the current date falls in between the effective dates inclusive.
  • any effective budget entry view: Budget entries of any effective date are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

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

    • canLookupBudgetEntries

      boolean canLookupBudgetEntries()
      Tests if this user can perform BudgetEntry 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 opt not to offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeBudgetEntryView

      void useComparativeBudgetEntryView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryBudgetEntryView

      void usePlenaryBudgetEntryView()
      A complete view of the BudgetEntry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include budget entries in businesses 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.

    • useEffectiveBudgetEntryView

      void useEffectiveBudgetEntryView()
      Only budget entries whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveBudgetEntryView

      void useAnyEffectiveBudgetEntryView()
      All budget entries of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getBudgetEntry

      BudgetEntry getBudgetEntry(Id budgetEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BudgetEntry specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned BudgetEntry may have a different Id than requested, such as the case where a duplicate Id was assigned to an BudgetEntry and retained for compatibility. In effective mode, budget entries are returned that are currently effective. In any effective mode, effective budget entries and those currently expired are returned.
      Parameters:
      budgetEntryId - Id of the BudgetEntry
      Returns:
      the entry
      Throws:
      NotFoundException - budgetEntryId not found
      NullArgumentException - budgetEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getBudgetEntriesByIds

      BudgetEntryList getBudgetEntriesByIds(IdList budgetEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an BudgetEntryList corresponding to the given IdList . In plenary mode, the returned list contains all of the budget entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible BudgetEntries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, budget entries are returned that are currently effective. In any effective mode, effective budget entries and those currently expired are returned.
      Parameters:
      budgetEntryIds - the list of Ids to retrieve
      Returns:
      the returned BudgetEntry list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - budgetEntryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesByGenusType

      BudgetEntryList getBudgetEntriesByGenusType(Type entryGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList corresponding to the given budget entry genus Type which does not include budget entries of genus types derived from the specified Type . In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Parameters:
      entryGenusType - a budget entry genus type
      Returns:
      the returned BudgetEntry list
      Throws:
      NullArgumentException - entryGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesByParentGenusType

      BudgetEntryList getBudgetEntriesByParentGenusType(Type entryGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList corresponding to the given budget entry genus Type and include any additional budget entries with genus types derived from the specified Type . In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Parameters:
      entryGenusType - a budget entry genus type
      Returns:
      the returned BudgetEntry list
      Throws:
      NullArgumentException - entryGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesByRecordType

      BudgetEntryList getBudgetEntriesByRecordType(Type budgetEntryRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList containing the given budget entry record Type . In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Parameters:
      budgetEntryRecordType - a budget entry record type
      Returns:
      the returned BudgetEntry list
      Throws:
      NullArgumentException - budgetEntryRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesOnDate

      BudgetEntryList getBudgetEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session. In effective mode, budget entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budget entries and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned BudgetEntryList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesForBudget

      BudgetEntryList getBudgetEntriesForBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList for the given budget. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Parameters:
      budgetId - a budget Id
      Returns:
      the returned BudgetEntry list
      Throws:
      NullArgumentException - budgetId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesForBudgetOnDate

      BudgetEntryList getBudgetEntriesForBudgetOnDate(Id budgetId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList for the given budget and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session. In effective mode, budget entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budget entries and those currently expired are returned.
      Parameters:
      budgetId - a budget Id
      from - start of date range
      to - end of date range
      Returns:
      the returned BudgetEntryList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - budgetId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesForAccount

      BudgetEntryList getBudgetEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList for the given account. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Parameters:
      accountId - an account Id
      Returns:
      the returned BudgetEntry list
      Throws:
      NullArgumentException - accountId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesForAccountOnDate

      BudgetEntryList getBudgetEntriesForAccountOnDate(Id accountId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList for the given account and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session. In effective mode, budget entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budget entries and those currently expired are returned.
      Parameters:
      accountId - an account Id
      from - start of date range
      to - end of date range
      Returns:
      the returned BudgetEntryList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - accountId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesForBudgetAndAccount

      BudgetEntryList getBudgetEntriesForBudgetAndAccount(Id budgetId, Id accountId) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList for the given budget and account. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Parameters:
      budgetId - a budget Id
      accountId - an account Id
      Returns:
      the returned BudgetEntry list
      Throws:
      NullArgumentException - budgetId or accountId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntriesForBudgetAndAccountOnDate

      BudgetEntryList getBudgetEntriesForBudgetAndAccountOnDate(Id budgetId, Id accountId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BudgetEntryList for the given budget, account, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session. In effective mode, budget entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budget entries and those currently expired are returned.
      Parameters:
      budgetId - a budget Id
      accountId - an account Id
      from - start of date range
      to - end of date range
      Returns:
      the returned BudgetEntryList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - budgetId, accountId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetEntries

      BudgetEntryList getBudgetEntries() throws OperationFailedException, PermissionDeniedException
      Gets all BudgetEntries . In plenary mode, the returned list contains all known budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.
      Returns:
      a list of BudgetEntries
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.