OSID - osid.rules.check.AgendaAdminSession Service Interface Definition

Interface	osid.rules.check.AgendaAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Agendas.` 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 `Agenda,` an `AgendaForm` is requested using `getAgendaFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AgendaForm` 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 `AgendaForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AgendaForm` corresponds to an attempted transaction. For updates, `AgendaForms` are requested to the `Agenda` `Id` that is to be updated using `getAgendaFormForUpdate().` Similarly, the `AgendaForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AgendaForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Agendas.` To unmap an `Agenda` from the current `Engine,` the `AgendaEngineAssignmentSession` should be used. These delete operations attempt to remove the `Agenda` itself thus removing it from all known `Engine` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAgendas
Description	Tests if this user can create `Agendas.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Agenda` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Agenda` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAgendaWithRecordTypes
Description	Tests if this user can create a single `Agenda` using the desired record types. While `RulesCheckManager.getAgendaRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Agenda.` Providing an empty array tests if an `Agenda` can be created with no records.
Parameters	`osid.type.Type[]`	`agendaRecordTypes`	array of agenda record types
Return	`boolean`		`true` if `Agenda` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agendaRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaFormForCreate
Description	Gets the agenda form for creating new agendas. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`agendaRecordTypes`	array of agenda record types
Return	`osid.rules.check.AgendaForm`		the agenda form
Errors	NULL_ARGUMENT		`agendaRecordTypes` 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	createAgenda
Description	Creates a new `Agenda.`
Parameters	`osid.rules.check.AgendaForm`	`agendaForm`	the form for this `Agenda`
Return	`osid.rules.check.Agenda`		the new `Agenda`
Errors	ILLEGAL_STATE		`agendaForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`agendaForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agendaForm` did not originate from `getAgendaFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAgendas
Description	Tests if this user can update `Agendas.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Agenda` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Agenda` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaFormForUpdate
Description	Gets the agenda form for updating an existing agenda. A new agenda form should be requested for each update transaction.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda`
Return	`osid.rules.check.AgendaForm`		the agenda form
Errors	NOT_FOUND		`agendaId` is not found
	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateAgenda
Description	Updates an existing agenda.
Parameters	`osid.rules.check.AgendaForm`	`agendaForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`agendaForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`agendaForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agendaForm` did not originate from `getAgendaFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAgendas
Description	Tests if this user can delete `Agendas.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Agenda` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Agenda` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAgenda
Description	Deletes an `Agenda.`
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda` to remove
Errors	NOT_FOUND		`agendaId` not found
	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAgendaAliases
Description	Tests if this user can manage `Id` aliases for `Agendas.` 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 `Agenda` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAgenda
Description	Adds an `Id` to an `Agenda` for the purpose of creating compatibility. The primary `Id` of the `Agenda` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another agenda, it is reassigned to the given agenda `Id.`
Parameters	`osid.id.Id`	`agendaId`	the `Id` of an `Agenda`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`agendaId` not found
	NULL_ARGUMENT		`agendaId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.