Interface PoolEnablerAdminSession

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

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

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

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

    • canCreatePoolEnablers

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

    • canCreatePoolEnablerWithRecordTypes

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

    • getPoolEnablerFormForCreate

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

    • createPoolEnabler

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

    • canUpdatePoolEnablers

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

    • getPoolEnablerFormForUpdate

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

    • updatePoolEnabler

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

    • canDeletePoolEnablers

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

    • deletePoolEnabler

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

    • canManagePoolEnablerAliases

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

    • aliasPoolEnabler

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