OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaAdminSession
Implementsosid.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.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAgendas
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.

Returnboolean false if Agenda creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAgendaWithRecordTypes
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.

Parametersosid.type.Type[]agendaRecordTypesarray of agenda record types
Returnboolean true if Agenda creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT agendaRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAgendaFormForCreate
Description

Gets the agenda form for creating new agendas. A new form should be requested for each create transaction.

Parametersosid.type.Type[]agendaRecordTypesarray of agenda record types
Returnosid.rules.check.AgendaFormthe agenda form
ErrorsNULL_ARGUMENT agendaRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAgenda
Description

Creates a new Agenda.

Parametersosid.rules.check.AgendaFormagendaFormthe form for this Agenda
Returnosid.rules.check.Agendathe new Agenda
ErrorsILLEGAL_STATE agendaForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT agendaForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agendaForm did not originate from getAgendaFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAgendas
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.

Returnboolean false if Agenda modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgendaFormForUpdate
Description

Gets the agenda form for updating an existing agenda. A new agenda form should be requested for each update transaction.

Parametersosid.id.IdagendaIdthe Id of the Agenda
Returnosid.rules.check.AgendaFormthe agenda form
ErrorsNOT_FOUND agendaId is not found
NULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodupdateAgenda
Description

Updates an existing agenda.

Parametersosid.rules.check.AgendaFormagendaFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE agendaForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT agendaForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agendaForm did not originate from getAgendaFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAgendas
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.

Returnboolean false if Agenda deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAgenda
Description

Deletes an Agenda.

Parametersosid.id.IdagendaIdthe Id of the Agenda to remove
ErrorsNOT_FOUND agendaId not found
NULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAgendaAliases
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.

Returnboolean false if Agenda aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAgenda
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.

Parametersosid.id.IdagendaIdthe Id of an Agenda
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND agendaId not found
NULL_ARGUMENT agendaId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.