OSID - osid.authentication.AgencyAdminSession Service Interface Definition

Interface	osid.authentication.AgencyAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Agencies.` 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 an `Agency,` an `AgencyForm` is requested using `getAgencyFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AgencyForm` 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 `AgencyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AgencyForm` corresponds to an attempted transaction. For updates, `AgencyForms` are requested to the `Agency` `Id` that is to be updated using `getAgencyFormForUpdate().` Similarly, the `AgencyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AgencyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Agencies.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateAgencies
Description	Tests if this user can create `Agencies.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Agency` 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 `Agency` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAgencyWithRecordTypes
Description	Tests if this user can create a single `Agency` using the desired record types. While `AuthenticationManager.getAgencyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Agency.` Providing an empty array tests if an `Agency` can be created with no records.
Parameters	`osid.type.Type[]`	`agencyRecordTypes`	array of agency record types
Return	`boolean`		`true` if `Agency` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agencyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgencyFormForCreate
Description	Gets the agency form for creating new agencies. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`agencyRecordTypes`	array of agency record types
Return	`osid.authentication.AgencyForm`		the agency form
Errors	NULL_ARGUMENT		`agencyRecordTypes` 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	createAgency
Description	Creates a new `Agency.`
Parameters	`osid.authentication.AgencyForm`	`agencyForm`	the form for this `Agency`
Return	`osid.authentication.Agency`		the new `Agency`
Errors	ILLEGAL_STATE		`agencyForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`agencyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agencyForm` did not originate from `getAgencyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAgencies
Description	Tests if this user can update `Agencies.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Agency` 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 `Agency` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgencyFormForUpdate
Description	Gets the agency form for updating an existing agency. A new agency form should be requested for each update transaction.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency`
Return	`osid.authentication.AgencyForm`		the agency form
Errors	NOT_FOUND		`agencyId` is not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAgency
Description	Updates an existing agency.
Parameters	`osid.authentication.AgencyForm`	`agencyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`agencyForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`agencyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agencyForm` did not originate from `getAgencyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAgencies
Description	Tests if this user can delete agencies. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Agency` 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 `Agency` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAgency
Description	Deletes an `Agency.`
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency` to remove
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAgencyAliases
Description	Tests if this user can manage `Id` aliases for `Agencies.` 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 `Agency` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAgency
Description	Adds an `Id` to an `Agency` for the purpose of creating compatibility. The primary `Id` of the `Agency` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another agency, it is reassigned to the given entry `Id.`
Parameters	`osid.id.Id`	`agencyId`	the `Id` of an `Agency`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.