org.osid.billing

Interface Business

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Business
extends OsidCatalog

A Business represents a collection of customers, categories, items, entries, and periods.

Method Summary

Methods

Modifier and Type	Method and Description
BusinessRecord	getBusinessRecord(Type businessRecordType) Gets the business record corresponding to the given Business record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getBusinessRecord

BusinessRecord getBusinessRecord(Type businessRecordType)
                                 throws OperationFailedException

Gets the business record corresponding to the given Business record Type. This method is used to retrieve an object implementing the requested record. The businessRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(businessRecordType) is true .

Parameters:

businessRecordType - the type of business record to retrieve

Returns:

the business record

Throws:

NullArgumentException - businessRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(businessRecordType) is false

Compliance:

mandatory - This method must be implemented.