OSID - osid.billing.PeriodForm Service Interface Definition

Interface	osid.billing.PeriodForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.billing.batch.PeriodBatchForm`
Used By	`osid.billing.PeriodAdminSession`
Description	This is the form for creating and updating `Periods`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PeriodAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getDisplayLabelMetadata
Description	Gets the metadata for a display label title.
Return	`osid.Metadata`		metadata for the display label
Compliance	`mandatory`		This method must be implemented.
Method	setDisplayLabel
Description	Sets the display label.
Parameters	`string`	`displayLabel`	the new display label
Errors	INVALID_ARGUMENT		`displayLabel` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`displayLabel` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDisplayLabel
Description	Removes the display label.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getOpenDateMetadata
Description	Gets the metadata for an open date.
Return	`osid.Metadata`		metadata for the open date
Compliance	`mandatory`		This method must be implemented.
Method	setOpenDate
Description	Sets the open date.
Parameters	`osid.calendaring.DateTime`	`date`	the new open date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOpenDate
Description	Clears the open date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCloseDateMetadata
Description	Gets the metadata for the close date.
Return	`osid.Metadata`		metadata for the close date
Compliance	`mandatory`		This method must be implemented.
Method	setCloseDate
Description	Sets the close date.
Parameters	`osid.calendaring.DateTime`	`date`	the new close date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCloseDate
Description	Clears the close date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBillingDateMetadata
Description	Gets the metadata for the billing date.
Return	`osid.Metadata`		metadata for the billing date
Compliance	`mandatory`		This method must be implemented.
Method	setBillingDate
Description	Sets the billing date.
Parameters	`osid.calendaring.DateTime`	`date`	the new billing date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBillingDate
Description	Clears the billing date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDueDateMetadata
Description	Gets the metadata for the due date.
Return	`osid.Metadata`		metadata for the due date
Compliance	`mandatory`		This method must be implemented.
Method	setDueDate
Description	Sets the due date.
Parameters	`osid.calendaring.DateTime`	`date`	the new due date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`date` cannot be modified
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDueDate
Description	Clears the due date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodFormRecord
Description	Gets the `PeriodFormRecord` corresponding to the given period record `Type`.
Parameters	`osid.type.Type`	`periodRecordType`	a period record type
Return	`osid.billing.records.PeriodFormRecord`		the period form 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.