Interface BillingLookupSession

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

This session provides methods for retrieving Billing objects. The Billing represents a collection of Credits .

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

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

  • Method Details

    • canLookupBillings

      boolean canLookupBillings()
      Tests if this user can perform Billing 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeBillingView

      void useComparativeBillingView()
      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.

    • usePlenaryBillingView

      void usePlenaryBillingView()
      A complete view of the Billing 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.

    • getBilling

      Billing getBilling(Id billingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Billing specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Billing may have a different Id than requested, such as the case where a duplicate Id was assigned to a Billing and retained for compatibility.
      Parameters:
      billingId - Id of the Billing
      Returns:
      the billing
      Throws:
      NotFoundException - billingId not found
      NullArgumentException - billingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getBillingsByIds

      BillingList getBillingsByIds(IdList billingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a BillingList corresponding to the given IdList . In plenary mode, the returned list contains all of the billings 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 Billings may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      billingIds - the list of Ids to retrieve
      Returns:
      the returned Billing list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - billingIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBillingsByGenusType

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

    • getBillingsByParentGenusType

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

    • getBillingsByRecordType

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

    • getBillingsByProvider

      BillingList getBillingsByProvider(Id providerId) throws OperationFailedException, PermissionDeniedException
      Gets a BillingList from the given Provider. In plenary mode, the returned list contains all known billings or an error results. Otherwise, the returned list may contain only those billings that are accessible through this session.
      Parameters:
      providerId - a provider Id
      Returns:
      the returned Billing list
      Throws:
      NullArgumentException - providerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBillings

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