OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ValueEnablerAdminSession
Implementsosid.OsidSession
Description

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

MethodgetConfigurationId
Description

Gets the Configuration Id associated with this session.

Returnosid.id.Idthe Configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfiguration
Description

Gets the Configuration associated with this session.

Returnosid.configuration.Configurationthe configuration
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateValueEnabler
Description

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

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

Parametersosid.type.Type[]valueEnablerRecordTypesarray of value enabler record types
Returnboolean true if ValueEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT valueEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerFormForCreate
Description

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

Parametersosid.type.Type[]valueEnablerRecordTypesarray of value enabler record types
Returnosid.configuration.rules.ValueEnablerFormthe value enabler form
ErrorsNULL_ARGUMENT valueEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateValueEnabler
Description

Creates a new ValueEnabler.

Parametersosid.configuration.rules.ValueEnablerFormvalueEnablerFormthe form for this ValueEnabler
Returnosid.configuration.rules.ValueEnablerthe new ValueEnabler
ErrorsILLEGAL_STATE valueEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT valueEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED valueEnablerForm did not originate from getValueEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateValueEnablers
Description

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

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

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler
Returnosid.configuration.rules.ValueEnablerFormthe value enabler form
ErrorsNOT_FOUND valueEnablerId is not found
NULL_ARGUMENT valueEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateValueEnabler
Description

Updates an existing value enabler.

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

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

Deletes a ValueEnabler.

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler to remove
ErrorsNOT_FOUND valueEnablerId not found
NULL_ARGUMENT valueEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageValueEnablerAliases
Description

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

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

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