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

This session creates and removes canonical unit processor enablers. The data for create and update is provided via the CanonicalUnitProcessorEnablerForm.

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

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

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

Parametersosid.type.Type[]canonicalUnitProcessorEnablerRecordTypesarray of canonical unit processor enabler record types
Returnboolean true if CanonicalUnitProcessorEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT canonicalUnitProcessorEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorEnablerFormForCreate
Description

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

Parametersosid.type.Type[]canonicalUnitProcessorEnablerRecordTypesarray of canonical unit processor enabler record types
Returnosid.offering.rules.CanonicalUnitProcessorEnablerFormthe canonical unit processor enabler form
ErrorsNULL_ARGUMENT canonicalUnitProcessorEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateCanonicalUnitProcessorEnabler
Description

Creates a new CanonicalUnitProcessorEnabler.

Parametersosid.offering.rules.CanonicalUnitProcessorEnablerFormcanonicalUnitProcessorEnablerFormthe form for this CanonicalUnitProcessorEnabler
Returnosid.offering.rules.CanonicalUnitProcessorEnablerthe new CanonicalUnitProcessorEnabler
ErrorsILLEGAL_STATE canonicalUnitProcessorEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT canonicalUnitProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitProcessorEnablerForm did not originate from getCanonicalUnitProcessorEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCanonicalUnitProcessorEnablers
Description

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

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

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of the CanonicalUnitProcessorEnabler
Returnosid.offering.rules.CanonicalUnitProcessorEnablerFormthe canonical unit processor enabler form
ErrorsNOT_FOUND canonicalUnitProcessorEnablerId is not found
NULL_ARGUMENT canonicalUnitProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCanonicalUnitProcessorEnabler
Description

Updates an existing canonical unit processor enabler.

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

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

Deletes a CanonicalUnitProcessorEnabler.

Parametersosid.id.IdcanonicalUnitProcessorEnablerIdthe Id of the CanonicalUnitProcessorEnabler to remove
ErrorsNOT_FOUND canonicalUnitProcessorEnablerId not found
NULL_ARGUMENT canonicalUnitProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageCanonicalUnitProcessorEnablerAliases
Description

Tests if this user can manage Id aliases for canonical unit processor 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 CanonicalUnitProcessorEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasCanonicalUnitProcessorEnabler
Description

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

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