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

This session creates and removes offering constrainers. The data for create and update is provided via the OfferingConstrainerForm.

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.
MethodcanCreateOfferingConstrainer
Description

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

OfferingRulesManager.getOfferingConstrainerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific OfferingConstrainer. Providing an empty array tests if an OfferingConstrainer can be created with no records.

Parametersosid.type.Type[]offeringConstrainerRecordTypesarray of offering constrainer record types
Returnboolean true if OfferingConstrainer creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT offeringConstrainerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerFormForCreate
Description

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

Parametersosid.type.Type[]offeringConstrainerRecordTypesarray of offering constrainer record types
Returnosid.offering.rules.OfferingConstrainerFormthe offering constrainer form
ErrorsNULL_ARGUMENT offeringConstrainerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateOfferingConstrainer
Description

Creates a new OfferingConstrainer.

Parametersosid.offering.rules.OfferingConstrainerFormofferingConstrainerFormthe form for this OfferingConstrainer
Returnosid.offering.rules.OfferingConstrainerthe new OfferingConstrainer
ErrorsILLEGAL_STATE offeringConstrainerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT offeringConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED offeringConstrainerForm did not originate from getOfferingConstrainerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateOfferingConstrainers
Description

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

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

Parametersosid.id.IdofferingConstrainerIdthe Id of the OfferingConstrainer
Returnosid.offering.rules.OfferingConstrainerFormthe offering constrainer form
ErrorsNOT_FOUND offeringConstrainerId is not found
NULL_ARGUMENT offeringConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOfferingConstrainer
Description

Updates an existing offering constrainer.

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

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

Deletes an OfferingConstrainer.

Parametersosid.id.IdofferingConstrainerIdthe Id of the OfferingConstrainer to remove
ErrorsNOT_FOUND offeringConstrainerId not found
NULL_ARGUMENT offeringConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageOfferingConstrainerAliases
Description

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

Adds an Id to an OfferingConstrainer for the purpose of creating compatibility. The primary Id of the OfferingConstrainer 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. it is reassigned to the given offering constrainer Id.

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