OSID - osid.billing.PeriodBusinessSession Service Interface Definition

Interface	osid.billing.PeriodBusinessSession
Implements	`osid.OsidSession`
Used By	`osid.billing.BillingManager`
Used By	`osid.billing.BillingProxyManager`
Description	This session provides methods to retrieve `Period` to `Business` mappings. A `Period` may appear in multiple `Businesses`. Each catalog may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupPeriodBusinessMappings
Description	Tests if this user can perform lookups of period/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePeriodBusinessView
Description	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.
Method	usePlenaryPeriodCatalogView
Description	A complete view of the `Period` and `Business` 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.
Method	getPeriodIdsByBusiness
Description	Gets the list of `Period Ids` associated with a `Business`.
Parameters	`osid.id.Id`	`businessId`	`Id` of the `Business`
Return	`osid.id.IdList`		list of related period `Ids`
Errors	NOT_FOUND		`businessId` is not found
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodsByBusiness
Description	Gets the list of `Period` associated with a `Business`.
Parameters	`osid.id.Id`	`businessId`	`Id` of the `Business`
Return	`osid.billing.PeriodList`		list of related periods
Errors	NOT_FOUND		`businessId` is not found
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodIdsByBusinesses
Description	Gets the list of `Period Ids` corresponding to a list of `Business` objects.
Parameters	`osid.id.IdList`	`businessIds`	list of catalog `Ids`
Return	`osid.id.IdList`		list of period `Ids`
Errors	NULL_ARGUMENT		`businessIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodsByBusinesses
Description	Gets the list of `Periods` corresponding to a list of `Business` objects.
Parameters	`osid.id.IdList`	`businessIds`	list of catalog `Ids`
Return	`osid.billing.PeriodList`		list of periods
Errors	NULL_ARGUMENT		`businessIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessIdsByPeriod
Description	Gets the `Business` `Ids` mapped to a `Period`.
Parameters	`osid.id.Id`	`periodId`	`Id` of a `Period`
Return	`osid.id.IdList`		list of businesses
Errors	NOT_FOUND		`periodId` is not found
	NULL_ARGUMENT		`periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessesByPeriod
Description	Gets the `Business` objects mapped to a `Period`.
Parameters	`osid.id.Id`	`periodId`	`Id` of a `Period`
Return	`osid.billing.BusinessList`		list of businesses
Errors	NOT_FOUND		`periodId` is not found
	NULL_ARGUMENT		`periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.