OSID - osid.billing.Period Service Interface Definition

Interface	osid.billing.Period
Implements	`osid.OsidObject`
Used By	`osid.billing.Entry`
	`osid.billing.PeriodAdminSession`
	`osid.billing.PeriodList`
	`osid.billing.PeriodLookupSession`
	`osid.billing.payment.Payment`
	`osid.billing.payment.Summary`
Description	A `Period` represents a billing period.
Method	getDisplayLabel
Description	Gets a display label for this period which may be less formal than the display name.
Return	`osid.locale.DisplayText`		the period label
Compliance	`mandatory`		This method must be implemented.
Method	hasOpenDate
Description	Tests if this period has an open date.
Return	`boolean`		`true` if there is an open date associated with this period, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOpenDate
Description	Gets the open date.
Return	`osid.calendaring.DateTime`		the open date
Errors	ILLEGAL_STATE		`hasOpenDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasCloseDate
Description	Tests if this period has a close date.
Return	`boolean`		`true` if there is a close date associated with this period, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCloseDate
Description	Gets the close date.
Return	`osid.calendaring.DateTime`		the close date
Errors	ILLEGAL_STATE		`hasCloseDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasBillingDate
Description	Tests if this period has a billing date.
Return	`boolean`		`true` if there is a billing date associated with this period, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBillingDate
Description	Gets the billing date.
Return	`osid.calendaring.DateTime`		the billing date
Errors	ILLEGAL_STATE		`hasBillingDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasDueDate
Description	Tests if this period has a due date.
Return	`boolean`		`true` if there is a due date associated with this period, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDueDate
Description	Gets the due date.
Return	`osid.calendaring.DateTime`		the due date
Errors	ILLEGAL_STATE		`hasDueDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodRecord
Description	Gets the period record corresponding to the given `Period` record `Type`.This method is used to retrieve an object implementing the requested record. The `periodRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(periodRecordType)` is `true`.
Parameters	`osid.type.Type`	`periodRecordType`	the type of period record to retrieve
Return	`osid.billing.records.PeriodRecord`		the period record
Errors	NULL_ARGUMENT		`periodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(periodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.