OSID Logo
OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.rules.CommitmentEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes commitment enablers. The data for create and update is provided via the CommitmentEnablerForm.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe calendar
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateCommitmentEnabler
Description

Tests if this user can create commitment enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a CommitmentEnabler 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 CommitmentEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateCommitmentEnablerWithRecordTypes
Description

Tests if this user can create a single CommitmentEnabler using the desired record types. While CalendaringRulesManager.getCommitmentEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific CommitmentEnabler. Providing an empty array tests if a CommitmentEnabler can be created with no records.

Parametersosid.type.Type[]commitmentEnablerRecordTypesarray of commitment enabler record types
Returnboolean true if CommitmentEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT commitmentEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentEnablerFormForCreate
Description

Gets the commitment enabler form for creating new commitment enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]commitmentEnablerRecordTypesarray of commitment enabler record types
Returnosid.calendaring.rules.CommitmentEnablerFormthe commitment enabler form
ErrorsNULL_ARGUMENT commitmentEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateCommitmentEnabler
Description

Creates a new CommitmentEnabler.

Parametersosid.calendaring.rules.CommitmentEnablerFormcommitmentEnablerFormthe form for this CommitmentEnabler
Returnosid.calendaring.rules.CommitmentEnablerthe new CommitmentEnabler
ErrorsILLEGAL_STATE commitmentEnablerForm already used in a create trsnaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT commitmentEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED commitmentEnablerForm did not originate from getCommitmentEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCommitmentEnablers
Description

Tests if this user can update commitment enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a CommitmentEnabler 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 CommitmentEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentEnablerFormForUpdate
Description

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

Parametersosid.id.IdcommitmentEnablerIdthe Id of the CommitmentEnabler
Returnosid.calendaring.rules.CommitmentEnablerFormthe commitment enabler form
ErrorsNOT_FOUND commitmentEnablerId is not found
NULL_ARGUMENT commitmentEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCommitmentEnabler
Description

Updates an existing commitment enabler.

Parametersosid.calendaring.rules.CommitmentEnablerFormcommitmentEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE commitmentEnablerForm already used in an update trsnaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT commitmentEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED commitmentEnablerForm did not originate from getCommitmentEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteCommitmentEnablers
Description

Tests if this user can delete commitment enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a CommitmentEnabler 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 CommitmentEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteCommitmentEnabler
Description

Deletes a CommitmentEnabler.

Parametersosid.id.IdcommitmentEnablerIdthe Id of the CommitmentEnabler to remove
ErrorsNOT_FOUND commitmentEnablerId not found
NULL_ARGUMENT commitmentEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageCommitmentEnablerAliases
Description

Tests if this user can manage Id aliases for commitment enablers. 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 CommitmentEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasCommitmentEnabler
Description

Adds an Id to a CommitmentEnabler for the purpose of creating compatibility. The primary Id of the CommitmentEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another commitment enabler. it is reassigned to the given commitment enabler Id.

Parametersosid.id.IdcommitmentEnablerIdthe Id of a CommitmentEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND commitmentEnablerId not found
NULL_ARGUMENT commitmentEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.