Interface | osid.configuration.ConfigurationAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateConfigurations | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Configuration creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateConfigurationWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | configurationRecordTypes | array of configuration record types |
Return | boolean | true if Configuration creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | configurationRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationFormForCreate | ||
Description |
Gets the configuration form for creating new configurations. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | configurationRecordTypes | array of configuration record types |
Return | osid.configuration.ConfigurationForm | the configuration form | |
Errors | NULL_ARGUMENT | configurationRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createConfiguration | ||
Description |
Creates a new | ||
Parameters | osid.configuration.ConfigurationForm | configurationForm | the configuration form |
Return | osid.configuration.Configuration | the new Configuration | |
Errors | ILLEGAL_STATE | configurationForm already used in a create transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | configurationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | configurationForm did not originate from
getConfigurationFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateConfigurations | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Configuration modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationFormForUpdate | ||
Description |
Gets the configuration form for updating existing configurations. A new configuration form should be requested for each update transaction. | ||
Parameters | osid.id.Id | configurationId | Id of a Configuration |
Return | osid.configuration.ConfigurationForm | the configuration form | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateConfiguration | ||
Description |
Updates an existing | ||
Parameters | osid.configuration.ConfigurationForm | configurationForm | the configuration form |
Errors | ILLEGAL_STATE | configurationForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | configurationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | configurationForm did not originate from
getConfigurationFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteConfigurations | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Configuration deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteConfiguration | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration to delete |
Errors | NOT_FOUND | configurationId not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageConfigurationAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Configuration aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasConfiguration | ||
Description |
Adds an | ||
Parameters | osid.id.Id | configurationId | the Id of a Configuration |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | configurationId not found | ||
NULL_ARGUMENT | configurationId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |