OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.AvailabilityEnablerAdminSession
Implementsosid.OsidSession
Description

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

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAvailabilityEnabler
Description

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

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

Parametersosid.type.Type[]availabilityEnablerRecordTypesarray of availability enabler record types
Returnboolean true if AvailabilityEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT availabilityEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerFormForCreate
Description

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

Parametersosid.type.Type[]availabilityEnablerRecordTypesarray of availability enabler record types
Returnosid.resourcing.rules.AvailabilityEnablerFormthe availability enabler form
ErrorsNULL_ARGUMENT availabilityEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form with requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAvailabilityEnabler
Description

Creates a new AvailabilityEnabler.

Parametersosid.resourcing.rules.AvailabilityEnablerFormavailabilityEnablerFormthe form for this AvailabilityEnabler
Returnosid.resourcing.rules.AvailabilityEnablerthe new AvailabilityEnabler
ErrorsILLEGAL_STATE availabilityEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT availabilityEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED availabilityEnablerForm did not originate from getAvailabilityEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAvailabilityEnablers
Description

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

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

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler
Returnosid.resourcing.rules.AvailabilityEnablerFormthe availability enabler form
ErrorsNOT_FOUND availabilityEnablerId is not found
NULL_ARGUMENT availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAvailabilityEnabler
Description

Updates an existing availability enabler.

Parametersosid.resourcing.rules.AvailabilityEnablerFormavailabilityEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE availabilityEnablerForm already used in an jupdate transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT availabilityEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED availabilityEnablerForm did not originate from getAvailabilityEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAvailabilityEnablers
Description

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

Deletes an AvailabilityEnabler.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler to remove
ErrorsNOT_FOUND availabilityEnablerId not found
NULL_ARGUMENT availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAvailabilityEnablerAliases
Description

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

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

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