Interface ProvisionEnablerAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ProvisionEnablerAdminSession extends OsidSession

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

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

The delete operations delete ProvisionEnablers . To unmap a ProvisionEnabler from the current Distributor , the ProvisionEnablerDistributorAssignmentSession should be used. These delete operations attempt to remove the ProvisionEnabler itself thus removing it from all known Distributor catalogs.

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

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canCreateProvisionEnablers

      boolean canCreateProvisionEnablers()
      Tests if this user can create ProvisionEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a ProvisionEnabler will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
      Returns:
      false if ProvisionEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateProvisionEnablerWithRecordTypes

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

    • getProvisionEnablerFormForCreate

      ProvisionEnablerForm getProvisionEnablerFormForCreate(Type[] provisionEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the provision enabler form for creating new provision enablers. A new form should be requested for each create transaction.
      Parameters:
      provisionEnablerRecordTypes - array of provision enabler record types
      Returns:
      the provision enabler form
      Throws:
      NullArgumentException - provisionEnablerRecordTypes 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.

    • createProvisionEnabler

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

    • canUpdateProvisionEnablers

      boolean canUpdateProvisionEnablers()
      Tests if this user can update ProvisionEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a ProvisionEnabler will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if ProvisionEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionEnablerFormForUpdate

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

    • updateProvisionEnabler

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

    • canDeleteProvisionEnablers

      boolean canDeleteProvisionEnablers()
      Tests if this user can delete ProvisionEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a ProvisionEnabler will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
      Returns:
      false if ProvisionEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteProvisionEnabler

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

    • canManageProvisionEnablerAliases

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

    • aliasProvisionEnabler

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