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

This session creates, updates, and deletes Configuration. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Configuration, a ConfigurationForm is requested using getConfigurationFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned ConfigurationForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the ConfigurationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ConfigurationForm corresponds to an attempted transaction.

For updates, ConfigurationForms are requested to the Configuration Id that is to be updated using getConfigurationFormForUpdate(). Similarly, the ConfigurationForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ConfigurationForm can only be used once for a successful update and cannot be reused.

The delete operations delete Configurations.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodcanCreateConfigurations
Description

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

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

Parametersosid.type.Type[]configurationRecordTypesarray of configuration record types
Returnboolean true if Configuration creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT configurationRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationFormForCreate
Description

Gets the configuration form for creating new configurations. A new form should be requested for each create transaction.

Parametersosid.type.Type[]configurationRecordTypesarray of configuration record types
Returnosid.configuration.ConfigurationFormthe configuration form
ErrorsNULL_ARGUMENT configurationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateConfiguration
Description

Creates a new Configuration.

Parametersosid.configuration.ConfigurationFormconfigurationFormthe configuration form
Returnosid.configuration.Configurationthe new Configuration
ErrorsILLEGAL_STATE configurationForm already used in a create transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT configurationForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED configurationForm did not originate from getConfigurationFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateConfigurations
Description

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

Gets the configuration form for updating existing configurations. A new configuration form should be requested for each update transaction.

Parametersosid.id.IdconfigurationId Id of a Configuration
Returnosid.configuration.ConfigurationFormthe configuration form
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateConfiguration
Description

Updates an existing Configuration.

Parametersosid.configuration.ConfigurationFormconfigurationFormthe configuration form
ErrorsILLEGAL_STATE configurationForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT configurationForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED configurationForm did not originate from getConfigurationFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteConfigurations
Description

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

Deletes a Configuration.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration to delete
ErrorsNOT_FOUND configurationId not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageConfigurationAliases
Description

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

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

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