Interface FiscalPeriodSmartBusinessSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A FiscalPeriodQuery can be retrieved from this session and mapped to this Business to create a virtual collection of FiscalPeriods . The fiscal periods may be sequenced using the FiscalPeriodSearchOrder from this session.

This Business has a default query that matches any fiscal period and a default search order that specifies no sequencing. The queries may be examined using a FiscalPeriodQueryInspector . The query may be modified by converting the inspector back to a FiscalPeriodQuery .

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

    • getFiscalPeriodQuery

      FiscalPeriodQuery getFiscalPeriodQuery()
      Gets a fiscal period query.
      Returns:
      the fiscal period query
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriodSearchOrder

      FiscalPeriodSearchOrder getFiscalPeriodSearchOrder()
      Gets a fiscal period search order.
      Returns:
      the fiscal period search order
      Compliance:
      mandatory - This method must be implemented.

    • applyFiscalPeriodQuery

      void applyFiscalPeriodQuery(FiscalPeriodQuery fiscalPeriodQuery) throws OperationFailedException, PermissionDeniedException
      Applies a fiscal period query to this business.
      Parameters:
      fiscalPeriodQuery - the fiscal period query
      Throws:
      NullArgumentException - fiscalPeriodQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - fiscalPeriodQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectFiscalPeriodQuery

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

    • applyFiscalPeriodSequencing

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

    • getFiscalPeriodQueryFromInspector

      FiscalPeriodQuery getFiscalPeriodQueryFromInspector(FiscalPeriodQueryInspector fiscalPeriodQueryInspector)
      Gets a fiscal period query from an inspector.
      Parameters:
      fiscalPeriodQueryInspector - a query inspector
      Returns:
      the fiscal period query
      Throws:
      NullArgumentException - fiscalPeriodQueryInspector is null
      UnsupportedException - fiscalPeriodQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.