OSID - osid.relationship.FamilyAdminSession Service Interface Definition

Interface	osid.relationship.FamilyAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Families.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Family,` a `FamilyForm` is requested using `getFamilyFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `FamilyForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `FamilyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `FamilyForm` corresponds to an attempted transaction. For updates, `FamilyForms` are requested to the `Family` `Id` that is to be updated using `getFamilyFormForUpdate().` Similarly, the `FamilyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `FamilyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Families.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateFamilies
Description	Tests if this user can create families. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Family` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Family` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFamilyWithRecordTypes
Description	Tests if this user can create a single `Family` using the desired record types. While `RelationshipManager.getFamilyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Family.` Providing an empty array tests if a `Family` can be created with no records.
Parameters	`osid.type.Type[]`	`familyRecordTypes`	array of family record types
Return	`boolean`		`true` if `Family` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`familyRecordTypes is null`
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyFormForCreate
Description	Gets the family form for creating new families. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`familyRecordTypes`	array of family record types
Return	`osid.relationship.FamilyForm`		the family form
Errors	NULL_ARGUMENT		`familyRecordTypes is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createFamily
Description	Creates a new `Family.`
Parameters	`osid.relationship.FamilyForm`	`familyForm`	the form for this `Family.`
Return	`osid.relationship.Family`		the new `Family`
Errors	ILLEGAL_STATE		`familyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`familyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`familyForm` did not originate from `getFamilyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateFamilies
Description	Tests if this user can update families. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Family` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Family` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyFormForUpdate
Description	Gets the family form for updating an existing family. A new family form should be requested for each update transaction.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.relationship.FamilyForm`		the family form
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateFamily
Description	Updates an existing family.
Parameters	`osid.relationship.FamilyForm`	`familyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`familyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`familyId` or `familyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`familyForm` did not originate from `getFamilyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteFamilies
Description	Tests if this user can delete families. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Family` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Family` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteFamily
Description	Deletes a `Family.`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family` to remove
Errors	NOT_FOUND		`familyId` not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageFamilyAliases
Description	Tests if this user can manage `Id` aliases for families. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Family` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasFamily
Description	Adds an `Id` to a `Family` for the purpose of creating compatibility. The primary `Id` of the `Family` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another family, it is reassigned to the given family `Id.`
Parameters	`osid.id.Id`	`familyId`	the `Id` of a `Family`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`familyId` not found
	NULL_ARGUMENT		`familyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.