Interface ModelAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ModelBatchAdminSession
public interface ModelAdminSession extends OsidSession

This session creates, updates, and deletes Models . 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 Model , a ModelForm is requested using getModelFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned ModelForm 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 ModelForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ModelForm corresponds to an attempted transaction.

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

The delete operations delete Models . To unmap a Model from the current Warehouse , the ModelWarehouseAssignmentSession should be used. These delete operations attempt to remove the Model itself thus removing it from all known Warehouse catalogs.

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

  • Method Details

    • getWarehouseId

      Id getWarehouseId()
      Gets the Warehouse Id associated with this session.
      Returns:
      the Warehouse Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouse

      Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
      Gets the Warehouse associated with this session.
      Returns:
      the warehouse
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canCreateModels

      boolean canCreateModels()
      Tests if this user can create Models . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Model 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.
      Returns:
      false if Model creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateModelWithRecordTypes

      boolean canCreateModelWithRecordTypes(Type[] modelRecordTypes)
      Tests if this user can create a single Model using the desired record types. While InventoryManager.getModelRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Model . Providing an empty array tests if a Model can be created with no records.
      Parameters:
      modelRecordTypes - array of model record types
      Returns:
      true if Model creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - modelRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getModelFormForCreate

      ModelForm getModelFormForCreate(Type[] modelRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the model form for creating new models. A new form should be requested for each create transaction.
      Parameters:
      modelRecordTypes - array of model record types
      Returns:
      the model form
      Throws:
      NullArgumentException - modelRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createModel

      Model createModel(ModelForm modelForm) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Creates a new Model .
      Parameters:
      modelForm - the form for this Model
      Returns:
      the new Model
      Throws:
      IllegalStateException - modelForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - courseId, termId , or modelForm is null
      NotFoundException - modelForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - modelForm did not originate from getModelFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateModels

      boolean canUpdateModels()
      Tests if this user can update Models . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Model 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.
      Returns:
      false if Model modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getModelFormForUpdate

      ModelForm getModelFormForUpdate(Id modelId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the model form for updating an existing model. A new model form should be requested for each update transaction.
      Parameters:
      modelId - the Id of the Model
      Returns:
      the model form
      Throws:
      NotFoundException - modelId is not found
      NullArgumentException - modelId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateModel

      void updateModel(ModelForm modelForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing model.
      Parameters:
      modelForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - modelForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - modelForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - modelForm did not originate from getModelFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteModels

      boolean canDeleteModels()
      Tests if this user can delete Models . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Model 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.
      Returns:
      false if Model deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteModel

      void deleteModel(Id modelId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes a Model .
      Parameters:
      modelId - the Id of the Model to remove
      Throws:
      NotFoundException - modelId not found
      NullArgumentException - modelId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageModelAliases

      boolean canManageModelAliases()
      Tests if this user can manage Id aliases for Models . 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.
      Returns:
      false if Model aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasModel

      void aliasModel(Id modelId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a Model for the purpose of creating compatibility. The primary Id of the Model is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another model, it is reassigned to the given model Id .
      Parameters:
      modelId - the Id of a Model
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is in use as a primary Id
      NotFoundException - modelId not found
      NullArgumentException - modelId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.