Interface BillingProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
BillingManager, BillingProxyManager
public interface BillingProfile extends OsidProfile

The billing profile describes the interoperability among billing management services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any business federation is exposed. Federation is exposed when a specific business may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerLookup

      boolean supportsCustomerLookup()
      Tests if looking up customers is supported.
      Returns:
      true if customer lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerQuery

      boolean supportsCustomerQuery()
      Tests if querying customers is supported.
      Returns:
      true if customer query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerSearch

      boolean supportsCustomerSearch()
      Tests if searching customers is supported.
      Returns:
      true if customer search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerAdmin

      boolean supportsCustomerAdmin()
      Tests if customer administrative service is supported.
      Returns:
      true if customer administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerNotification

      boolean supportsCustomerNotification()
      Tests if a customer notification service is supported.
      Returns:
      true if customer notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerBusiness

      boolean supportsCustomerBusiness()
      Tests if a businessing service is supported.
      Returns:
      true if businessing is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerBusinessAssignment

      boolean supportsCustomerBusinessAssignment()
      Tests if a businessing service is supported. A businessing service maps customers to catalogs.
      Returns:
      true if businessing is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerSmartBusiness

      boolean supportsCustomerSmartBusiness()
      Tests if a customer smart business session is available.
      Returns:
      true if a customer smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemLookup

      boolean supportsItemLookup()
      Tests if looking up items is supported.
      Returns:
      true if item lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemQuery

      boolean supportsItemQuery()
      Tests if querying items is supported.
      Returns:
      true if item query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSearch

      boolean supportsItemSearch()
      Tests if searching items is supported.
      Returns:
      true if item search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemAdmin

      boolean supportsItemAdmin()
      Tests if an item administrative service is supported.
      Returns:
      true if item administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemNotification

      boolean supportsItemNotification()
      Tests if an item notification service is supported.
      Returns:
      true if item notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemBusiness

      boolean supportsItemBusiness()
      Tests if an item cataloging service is supported.
      Returns:
      true if item catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemBusinessAssignment

      boolean supportsItemBusinessAssignment()
      Tests if an item cataloging service is supported. A cataloging service maps items to catalogs.
      Returns:
      true if item cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSmartBusiness

      boolean supportsItemSmartBusiness()
      Tests if an item smart business session is available.
      Returns:
      true if an item smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryLookup

      boolean supportsCategoryLookup()
      Tests if looking up categories is supported.
      Returns:
      true if category lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryQuery

      boolean supportsCategoryQuery()
      Tests if querying categories is supported.
      Returns:
      true if category query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategorySearch

      boolean supportsCategorySearch()
      Tests if searching categories is supported.
      Returns:
      true if category search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryAdmin

      boolean supportsCategoryAdmin()
      Tests if category administrative service is supported.
      Returns:
      true if category administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryNotification

      boolean supportsCategoryNotification()
      Tests if a category notification service is supported.
      Returns:
      true if category notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryBusiness

      boolean supportsCategoryBusiness()
      Tests if a category cataloging service is supported.
      Returns:
      true if category catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryBusinessAssignment

      boolean supportsCategoryBusinessAssignment()
      Tests if a category cataloging service is supported. A cataloging service maps categories to catalogs.
      Returns:
      true if category cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategorySmartBusiness

      boolean supportsCategorySmartBusiness()
      Tests if a category smart business session is available.
      Returns:
      true if a category smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryLookup

      boolean supportsEntryLookup()
      Tests if looking up entries is supported.
      Returns:
      true if entry lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryQuery

      boolean supportsEntryQuery()
      Tests if querying entries is supported.
      Returns:
      true if entry query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntrySearch

      boolean supportsEntrySearch()
      Tests if searching entries is supported.
      Returns:
      true if entry search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryAdmin

      boolean supportsEntryAdmin()
      Tests if entry administrative service is supported.
      Returns:
      true if entry administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryNotification

      boolean supportsEntryNotification()
      Tests if an entry notification service is supported.
      Returns:
      true if entry notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryBusiness

      boolean supportsEntryBusiness()
      Tests if an entry cataloging service is supported.
      Returns:
      true if entry catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryBusinessAssignment

      boolean supportsEntryBusinessAssignment()
      Tests if an entry cataloging service is supported. A cataloging service maps entries to catalogs.
      Returns:
      true if entry cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntrySmartBusiness

      boolean supportsEntrySmartBusiness()
      Tests if an entry smart business session is available.
      Returns:
      true if an entry smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodLookup

      boolean supportsPeriodLookup()
      Tests if looking up periods is supported.
      Returns:
      true if period lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodQuery

      boolean supportsPeriodQuery()
      Tests if querying periods is supported.
      Returns:
      true if period query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodSearch

      boolean supportsPeriodSearch()
      Tests if searching periods is supported.
      Returns:
      true if period search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodAdmin

      boolean supportsPeriodAdmin()
      Tests if period administrative service is supported.
      Returns:
      true if period administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodNotification

      boolean supportsPeriodNotification()
      Tests if a period notification service is supported.
      Returns:
      true if period notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodBusiness

      boolean supportsPeriodBusiness()
      Tests if a period cataloging service is supported.
      Returns:
      true if period catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodBusinessAssignment

      boolean supportsPeriodBusinessAssignment()
      Tests if a period cataloging service is supported. A cataloging service maps periods to catalogs.
      Returns:
      true if period cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodSmartBusiness

      boolean supportsPeriodSmartBusiness()
      Tests if a period smart business session is available.
      Returns:
      true if a period smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessLookup

      boolean supportsBusinessLookup()
      Tests if looking up businesses is supported.
      Returns:
      true if business lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessSearch

      boolean supportsBusinessSearch()
      Tests if searching businesses is supported.
      Returns:
      true if business search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessQuery

      boolean supportsBusinessQuery()
      Tests if querying businesses is supported.
      Returns:
      true if business query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessAdmin

      boolean supportsBusinessAdmin()
      Tests if business administrative service is supported.
      Returns:
      true if business administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessNotification

      boolean supportsBusinessNotification()
      Tests if a business notification service is supported.
      Returns:
      true if business notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessHierarchy

      boolean supportsBusinessHierarchy()
      Tests for the availability of a business hierarchy traversal service.
      Returns:
      true if business hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsBusinessHierarchyDesign

      boolean supportsBusinessHierarchyDesign()
      Tests for the availability of a business hierarchy design service.
      Returns:
      true if business hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBillingBatch

      boolean supportsBillingBatch()
      Tests for the availability of a billing batch service.
      Returns:
      true if a billing batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBillingPayment

      boolean supportsBillingPayment()
      Tests for the availability of a billing payment service.
      Returns:
      true if a billing payment service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerRecordTypes

      TypeList getCustomerRecordTypes()
      Gets the supported Customer record types.
      Returns:
      a list containing the supported Customer record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerRecordType

      boolean supportsCustomerRecordType(Type customerRecordType)
      Tests if the given Customer record type is supported.
      Parameters:
      customerRecordType - a Type indicating a Customer record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - customerRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerSearchRecordTypes

      TypeList getCustomerSearchRecordTypes()
      Gets the supported Customer search record types.
      Returns:
      a list containing the supported Customer search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerSearchRecordType

      boolean supportsCustomerSearchRecordType(Type customerSearchRecordType)
      Tests if the given Customer search record type is supported.
      Parameters:
      customerSearchRecordType - a Type indicating a Customer search record type
      Returns:
      true if the given search record type is supported, false otherwise
      Throws:
      NullArgumentException - customerSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getItemRecordTypes

      TypeList getItemRecordTypes()
      Gets the supported Item record types.
      Returns:
      a list containing the supported Item record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemRecordType

      boolean supportsItemRecordType(Type itemRecordType)
      Tests if the given Item record type is supported.
      Parameters:
      itemRecordType - a Type indicating an Item record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - itemRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getItemSearchRecordTypes

      TypeList getItemSearchRecordTypes()
      Gets the supported Item search record types.
      Returns:
      a list containing the supported Item search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSearchRecordType

      boolean supportsItemSearchRecordType(Type itemSearchRecordType)
      Tests if the given Item search record type is supported.
      Parameters:
      itemSearchRecordType - a Type indicating an Item search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - itemSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCategoryRecordTypes

      TypeList getCategoryRecordTypes()
      Gets the supported Category record types.
      Returns:
      a list containing the supported Category record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategoryRecordType

      boolean supportsCategoryRecordType(Type categoryRecordType)
      Tests if the given Category record type is supported.
      Parameters:
      categoryRecordType - a Type indicating an Category record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - categoryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCategorySearchRecordTypes

      TypeList getCategorySearchRecordTypes()
      Gets the supported Category search record types.
      Returns:
      a list containing the supported Category search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCategorySearchRecordType

      boolean supportsCategorySearchRecordType(Type categorySearchRecordType)
      Tests if the given Category search record type is supported.
      Parameters:
      categorySearchRecordType - a Type indicating an Category search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - categorySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEntryRecordTypes

      TypeList getEntryRecordTypes()
      Gets the supported Entry record types.
      Returns:
      a list containing the supported Entry record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryRecordType

      boolean supportsEntryRecordType(Type entryRecordType)
      Tests if the given Entry record type is supported.
      Parameters:
      entryRecordType - a Type indicating an Entry record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - entryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEntrySearchRecordTypes

      TypeList getEntrySearchRecordTypes()
      Gets the supported Entry search record types.
      Returns:
      a list containing the supported Entry search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntrySearchRecordType

      boolean supportsEntrySearchRecordType(Type entrySearchRecordType)
      Tests if the given Entry search record type is supported.
      Parameters:
      entrySearchRecordType - a Type indicating an Entry search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - entrySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodRecordTypes

      TypeList getPeriodRecordTypes()
      Gets the supported Period record types.
      Returns:
      a list containing the supported Period record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodRecordType

      boolean supportsPeriodRecordType(Type periodRecordType)
      Tests if the given Period record type is supported.
      Parameters:
      periodRecordType - a Type indicating a Period record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - periodRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodSearchRecordTypes

      TypeList getPeriodSearchRecordTypes()
      Gets the supported Period search record types.
      Returns:
      a list containing the supported Period search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPeriodSearchRecordType

      boolean supportsPeriodSearchRecordType(Type periodSearchRecordType)
      Tests if the given Period search record type is supported.
      Parameters:
      periodSearchRecordType - a Type indicating a Period search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - periodSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessRecordTypes

      TypeList getBusinessRecordTypes()
      Gets the supported Business record types.
      Returns:
      a list containing the supported Business types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessRecordType

      boolean supportsBusinessRecordType(Type businessRecordType)
      Tests if the given Business record type is supported.
      Parameters:
      businessRecordType - a Type indicating an Business record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - businessRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessSearchRecordTypes

      TypeList getBusinessSearchRecordTypes()
      Gets the supported Business search record types.
      Returns:
      a list containing the supported Business search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessSearchRecordType

      boolean supportsBusinessSearchRecordType(Type businessSearchRecordType)
      Tests if the given Business search record type is supported.
      Parameters:
      businessSearchRecordType - a Type indicating an Business search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - businessSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.