OSID - osid.billing.BillingProfile Service Interface Definition

Interface	osid.billing.BillingProfile
Implements	`osid.OsidProfile`
Description	The billing profile describes the interoperability among billing management services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerLookup
Description	Tests if looking up customers is supported.
Return	`boolean`		`true` if customer lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerQuery
Description	Tests if querying customers is supported.
Return	`boolean`		`true` if customer query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerSearch
Description	Tests if searching customers is supported.
Return	`boolean`		`true` if customer search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerAdmin
Description	Tests if customer administrative service is supported.
Return	`boolean`		`true` if customer administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerNotification
Description	Tests if a customer notification service is supported.
Return	`boolean`		`true` if customer notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerBusiness
Description	Tests if a businessing service is supported.
Return	`boolean`		`true` if businessing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerBusinessAssignment
Description	Tests if a businessing service is supported. A businessing service maps customers to catalogs.
Return	`boolean`		`true` if businessing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerSmartBusiness
Description	Tests if a customer smart business session is available.
Return	`boolean`		`true` if a customer smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemLookup
Description	Tests if looking up items is supported.
Return	`boolean`		`true` if item lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if querying items is supported.
Return	`boolean`		`true` if item query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSearch
Description	Tests if searching items is supported.
Return	`boolean`		`true` if item search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemAdmin
Description	Tests if an item administrative service is supported.
Return	`boolean`		`true` if item administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemNotification
Description	Tests if an item notification service is supported.
Return	`boolean`		`true` if item notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemBusiness
Description	Tests if an item cataloging service is supported.
Return	`boolean`		`true` if item catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemBusinessAssignment
Description	Tests if an item cataloging service is supported. A cataloging service maps items to catalogs.
Return	`boolean`		`true` if item cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSmartBusiness
Description	Tests if an item smart business session is available.
Return	`boolean`		`true` if an item smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryLookup
Description	Tests if looking up categories is supported.
Return	`boolean`		`true` if category lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryQuery
Description	Tests if querying categories is supported.
Return	`boolean`		`true` if category query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategorySearch
Description	Tests if searching categories is supported.
Return	`boolean`		`true` if category search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryAdmin
Description	Tests if category administrative service is supported.
Return	`boolean`		`true` if category administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryNotification
Description	Tests if a category notification service is supported.
Return	`boolean`		`true` if category notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryBusiness
Description	Tests if a category cataloging service is supported.
Return	`boolean`		`true` if category catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryBusinessAssignment
Description	Tests if a category cataloging service is supported. A cataloging service maps categories to catalogs.
Return	`boolean`		`true` if category cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategorySmartBusiness
Description	Tests if a category smart business session is available.
Return	`boolean`		`true` if a category smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryLookup
Description	Tests if looking up entries is supported.
Return	`boolean`		`true` if entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if querying entries is supported.
Return	`boolean`		`true` if entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySearch
Description	Tests if searching entries is supported.
Return	`boolean`		`true` if entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryAdmin
Description	Tests if entry administrative service is supported.
Return	`boolean`		`true` if entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryNotification
Description	Tests if an entry notification service is supported.
Return	`boolean`		`true` if entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryBusiness
Description	Tests if an entry cataloging service is supported.
Return	`boolean`		`true` if entry catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryBusinessAssignment
Description	Tests if an entry cataloging service is supported. A cataloging service maps entries to catalogs.
Return	`boolean`		`true` if entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySmartBusiness
Description	Tests if an entry smart business session is available.
Return	`boolean`		`true` if an entry smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodLookup
Description	Tests if looking up periods is supported.
Return	`boolean`		`true` if period lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodQuery
Description	Tests if querying periods is supported.
Return	`boolean`		`true` if period query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodSearch
Description	Tests if searching periods is supported.
Return	`boolean`		`true` if period search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodAdmin
Description	Tests if period administrative service is supported.
Return	`boolean`		`true` if period administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodNotification
Description	Tests if a period notification service is supported.
Return	`boolean`		`true` if period notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodBusiness
Description	Tests if a period cataloging service is supported.
Return	`boolean`		`true` if period catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodBusinessAssignment
Description	Tests if a period cataloging service is supported. A cataloging service maps periods to catalogs.
Return	`boolean`		`true` if period cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodSmartBusiness
Description	Tests if a period smart business session is available.
Return	`boolean`		`true` if a period smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessLookup
Description	Tests if looking up businesses is supported.
Return	`boolean`		`true` if business lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessSearch
Description	Tests if searching businesses is supported.
Return	`boolean`		`true` if business search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if querying businesses is supported.
Return	`boolean`		`true` if business query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessAdmin
Description	Tests if business administrative service is supported.
Return	`boolean`		`true` if business administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessNotification
Description	Tests if a business notification service is supported.
Return	`boolean`		`true` if business notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessHierarchy
Description	Tests for the availability of a business hierarchy traversal service.
Return	`boolean`		`true` if business hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsBusinessHierarchyDesign
Description	Tests for the availability of a business hierarchy design service.
Return	`boolean`		`true` if business hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBillingBatch
Description	Tests for the availability of a billing batch service.
Return	`boolean`		`true` if a billing batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBillingPayment
Description	Tests for the availability of a billing payment service.
Return	`boolean`		`true` if a billing payment service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerRecordTypes
Description	Gets the supported `Customer` record types.
Return	`osid.type.TypeList`		a list containing the supported `Customer` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerRecordType
Description	Tests if the given `Customer` record type is supported.
Parameters	`osid.type.Type`	`customerRecordType`	a `Type` indicating a `Customer` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`customerRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchRecordTypes
Description	Gets the supported `Customer` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Customer` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerSearchRecordType
Description	Tests if the given `Customer` search record type is supported.
Parameters	`osid.type.Type`	`customerSearchRecordType`	a `Type` indicating a `Customer` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`customerSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getItemRecordTypes
Description	Gets the supported `Item` record types.
Return	`osid.type.TypeList`		a list containing the supported `Item` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemRecordType
Description	Tests if the given `Item` record type is supported.
Parameters	`osid.type.Type`	`itemRecordType`	a `Type` indicating an `Item` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getItemSearchRecordTypes
Description	Gets the supported `Item` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Item` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSearchRecordType
Description	Tests if the given `Item` search record type is supported.
Parameters	`osid.type.Type`	`itemSearchRecordType`	a `Type` indicating an `Item` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`itemSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCategoryRecordTypes
Description	Gets the supported `Category` record types.
Return	`osid.type.TypeList`		a list containing the supported `Category` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryRecordType
Description	Tests if the given `Category` record type is supported.
Parameters	`osid.type.Type`	`categoryRecordType`	a `Type` indicating an `Category` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`categoryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCategorySearchRecordTypes
Description	Gets the supported `Category` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Category` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategorySearchRecordType
Description	Tests if the given `Category` search record type is supported.
Parameters	`osid.type.Type`	`categorySearchRecordType`	a `Type` indicating an `Category` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`categorySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryRecordTypes
Description	Gets the supported `Entry` record types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryRecordType
Description	Tests if the given `Entry` record type is supported.
Parameters	`osid.type.Type`	`entryRecordType`	a `Type` indicating an `Entry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntrySearchRecordTypes
Description	Gets the supported `Entry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySearchRecordType
Description	Tests if the given `Entry` search record type is supported.
Parameters	`osid.type.Type`	`entrySearchRecordType`	a `Type` indicating an `Entry` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodRecordTypes
Description	Gets the supported `Period` record types.
Return	`osid.type.TypeList`		a list containing the supported `Period` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodRecordType
Description	Tests if the given `Period` record type is supported.
Parameters	`osid.type.Type`	`periodRecordType`	a `Type` indicating a `Period` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`periodRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodSearchRecordTypes
Description	Gets the supported `Period` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Period` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodSearchRecordType
Description	Tests if the given `Period` search record type is supported.
Parameters	`osid.type.Type`	`periodSearchRecordType`	a `Type` indicating a `Period` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`periodSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessRecordTypes
Description	Gets the supported `Business` record types.
Return	`osid.type.TypeList`		a list containing the supported `Business` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessRecordType
Description	Tests if the given `Business` record type is supported.
Parameters	`osid.type.Type`	`businessRecordType`	a `Type` indicating an `Business` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`businessRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessSearchRecordTypes
Description	Gets the supported `Business` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Business` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessSearchRecordType
Description	Tests if the given `Business` search record type is supported.
Parameters	`osid.type.Type`	`businessSearchRecordType`	a `Type` indicating an `Business` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`businessSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.