OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes offering constrainer enablers. The data for create and update is provided via the OfferingConstrainerEnablerForm.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe catalogue
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateOfferingConstrainerEnabler
Description

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

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

Parametersosid.type.Type[]offeringConstrainerEnablerRecordTypesarray of offering constrainer enabler record types
Returnboolean true if OfferingConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT offeringConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablerFormForCreate
Description

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

Parametersosid.type.Type[]offeringConstrainerEnablerRecordTypesarray of offering constrainer enabler record types
Returnosid.offering.rules.OfferingConstrainerEnablerFormthe offering constrainer enabler form
ErrorsNULL_ARGUMENT offeringConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateOfferingConstrainerEnabler
Description

Creates a new OfferingConstrainerEnabler.

Parametersosid.offering.rules.OfferingConstrainerEnablerFormofferingConstrainerEnablerFormthe form for this OfferingConstrainerEnabler
Returnosid.offering.rules.OfferingConstrainerEnablerthe new OfferingConstrainerEnabler
ErrorsILLEGAL_STATE offeringConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT offeringConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED offeringConstrainerEnablerForm did not originate from getOfferingConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateOfferingConstrainerEnablers
Description

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

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

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler
Returnosid.offering.rules.OfferingConstrainerEnablerFormthe offering constrainer enabler form
ErrorsNOT_FOUND offeringConstrainerEnablerId is not found
NULL_ARGUMENT offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOfferingConstrainerEnabler
Description

Updates an existing offering constrainer enabler.

Parametersosid.offering.rules.OfferingConstrainerEnablerFormofferingConstrainerEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE offeringConstrainerEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT offeringConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED offeringConstrainerEnablerForm did not originate from getOfferingConstrainerEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteOfferingConstrainerEnablers
Description

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

Deletes an OfferingConstrainerEnabler.

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler to remove
ErrorsNOT_FOUND offeringConstrainerEnablerId not found
NULL_ARGUMENT offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageOfferingConstrainerEnablerAliases
Description

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

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

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