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

This session creates and removes parameter processor enablers. The data for create and update is provided via the ParameterProcessorEnablerForm.

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

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

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

Parametersosid.type.Type[]parameterProcessorEnablerRecordTypesarray of parameter processor enabler record types
Returnboolean true if ParameterProcessorEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT parameterProcessorEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerFormForCreate
Description

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

Parametersosid.type.Type[]parameterProcessorEnablerRecordTypesarray of parameter processor enabler record types
Returnosid.configuration.rules.ParameterProcessorEnablerFormthe parameter processor enabler form
ErrorsNULL_ARGUMENT parameterProcessorEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateParameterProcessorEnabler
Description

Creates a new ParameterProcessorEnabler.

Parametersosid.configuration.rules.ParameterProcessorEnablerFormparameterProcessorEnablerFormthe form for this ParameterProcessorEnabler
Returnosid.configuration.rules.ParameterProcessorEnablerthe new ParameterProcessorEnabler
ErrorsILLEGAL_STATE parameterProcessorEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT parameterProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED parameterProcessorEnablerForm did not originate from getParameterProcessorEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateParameterProcessorEnablers
Description

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

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

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler
Returnosid.configuration.rules.ParameterProcessorEnablerFormthe parameter processor enabler form
ErrorsNOT_FOUND parameterProcessorEnablerId is not found
NULL_ARGUMENT parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateParameterProcessorEnabler
Description

Updates an existing parameter processor enabler.

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

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

Deletes a ParameterProcessorEnabler.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler to remove
ErrorsNOT_FOUND parameterProcessorEnablerId not found
NULL_ARGUMENT parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageParameterProcessorEnablerAliases
Description

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

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

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