OSID - osid.financials.ActivityForm Service Interface Definition

Interface	osid.financials.ActivityForm
Implements	`osid.OsidObjectForm`
	`osid.OsidFederateableForm`
	`osid.OsidTemporalForm`
Implemented By	`osid.financials.batch.ActivityBatchForm`
Used By	`osid.financials.ActivityAdminSession`
Description	This is the form for creating and updating `Activities`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `ActivityAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getOrganizationMetadata
Description	Gets the metadata for the organization.
Return	`osid.Metadata`		metadata for the organization
Compliance	`mandatory`		This method must be implemented.
Method	setOrganization
Description	Sets the organization.
Parameters	`osid.id.Id`	`organizationId`	the new organization
Errors	INVALID_ARGUMENT		`organizationId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`organizationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOrganization
Description	Removes the organization.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSupervisorMetadata
Description	Gets the metadata for the supervisor.
Return	`osid.Metadata`		metadata for the supervisor
Compliance	`mandatory`		This method must be implemented.
Method	setSupervisor
Description	Sets the supervisor.
Parameters	`osid.id.Id`	`supervisorId`	the new supervisor
Errors	INVALID_ARGUMENT		`supervisorId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`supervisorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSupervisor
Description	Removes the supervisor.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCodeMetadata
Description	Gets the metadata for the code flag.
Return	`osid.Metadata`		metadata for the code
Compliance	`mandatory`		This method must be implemented.
Method	setCode
Description	Sets the code.
Parameters	`string`	`code`	the new code
Errors	INVALID_ARGUMENT		`code` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCode
Description	Removes the code.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityFormRecord
Description	Gets the `ActivityFormRecord` corresponding to the given activity record `Type`.
Parameters	`osid.type.Type`	`activityRecordType`	an activity record type
Return	`osid.financials.records.ActivityFormRecord`		the activity form record
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(activityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.