Interface ProvisionableEnablerAdminSession

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

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

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

The delete operations delete ProvisionableEnablers . To unmap a ProvisionableEnabler from the current Distributor , the ProvisionableEnablerDistributorAssignmentSession should be used. These delete operations attempt to remove the ProvisionableEnabler 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.

    • canCreateProvisionableEnablers

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

    • canCreateProvisionableEnablerWithRecordTypes

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

    • getProvisionableEnablerFormForCreate

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

    • createProvisionableEnabler

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

    • canUpdateProvisionableEnablers

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

    • getProvisionableEnablerFormForUpdate

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

    • updateProvisionableEnabler

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

    • canDeleteProvisionableEnablers

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

    • deleteProvisionableEnabler

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

    • canManageProvisionableEnablerAliases

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

    • aliasProvisionableEnabler

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