OSID - osid.relationship.batch.FamilyBatchForm Service Interface Definition

Interface	osid.relationship.batch.FamilyBatchForm
Implements	`osid.relationship.FamilyForm`
Used By	`osid.relationship.batch.FamilyBatchFormList`
Description	This is the form for creating and updating families in bulk. Like all `OsidForms` , various data elements may be set here for use in the create and update methods in the `FamilyBatchAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getFamilyId
Description	Gets the `Family Id` of the family to be updated if this is an update transaction.
Return	`osid.id.Id`		the family `Id`
Errors	ILLEGAL_STATE		`isForUpdate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getParentsMetadata
Description	Gets the metadata for setting the hierarchical parents of this family.
Return	`osid.Metadata`		metadata for the parents
Compliance	`mandatory`		This method must be implemented.
Method	setParents
Description	Sets the hierarchical parents.
Parameters	`osid.id.Id[]`	`parents`	the new parents
Errors	INVALID_ARGUMENT		`parents` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`parents` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParents
Description	Removes the hierarchical parents.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.