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

This session provides methods to re-assign OfferingConstrainerEnabler to Catalogue mappings. An OfferingConstrainerEnabler may appear in multiple Catalogue objects and removing the last reference to an OfferingConstrainerEnabler is the equivalent of deleting it. Each Catalogue may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an OfferingConstrainerEnabler to another Catalogue is not a copy operation (eg: does not change its Id ).

MethodcanAssignOfferingConstrainerEnablers
Description

Tests if this user can alter offering constrainer enabler/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignOfferingConstrainerEnablersToCatalogue
Description

Tests if this user can alter offering constrainer enabler/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT catalogueId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCatalogueIds
Description

Gets a list of catalogues including and under the given catalogue node in which any offering constrainer enabler can be assigned.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnosid.id.IdListlist of assignable catalogue Ids
ErrorsNULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCatalogueIdsForOfferingConstrainerEnabler
Description

Gets a list of catalogues including and under the given catalogue node in which a specific offering constrainer enabler can be assigned.

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
osid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler
Returnosid.id.IdListlist of assignable catalogue Ids
ErrorsNULL_ARGUMENT catalogueId or offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignOfferingConstrainerEnablerToCatalogue
Description

Adds an existing OfferingConstrainerEnabler to a Catalogue.

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler
osid.id.IdcatalogueIdthe Id of the Catalogue
ErrorsALREADY_EXISTS offeringConstrainerEnablerId already assigned to catalogueId
NOT_FOUND offeringConstrainerEnablerId or catalogueId not found
NULL_ARGUMENT offeringConstrainerEnablerId or catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignOfferingConstrainerEnablerFromCatalogue
Description

Removes an OfferingConstrainerEnabler from a Catalogue.

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler
osid.id.IdcatalogueIdthe Id of the Catalogue
ErrorsNOT_FOUND offeringConstrainerEnablerId or catalogueId not found or offeringConstrainerEnablerId already assigned to catalogueId
NULL_ARGUMENT offeringConstrainerEnablerId or catalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignOfferingConstrainerEnablerToCatalogue
Description

Moves an OfferingConstrainerEnabler from one Catalogue to another. Mappings to other Catalogues are unaffected.

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler
osid.id.IdfromCatalogueIdthe Id of the current Catalogue
osid.id.IdtoCatalogueIdthe Id of the destination Catalogue
ErrorsNOT_FOUND offeringConstrainerEnablerId, fromCatalogueId, or toCatalogueId not found or offeringConstrainerEnablerId, not mapped to fromCatalogueId
NULL_ARGUMENT offeringConstrainerEnablerId, fromCatalogueId, or toCatalogueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.