Interface PoolConstrainerAdminSession

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

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

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

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

    • canCreatePoolConstrainers

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

    • canCreatePoolConstrainerWithRecordTypes

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

    • getPoolConstrainerFormForCreate

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

    • createPoolConstrainer

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

    • canUpdatePoolConstrainers

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

    • getPoolConstrainerFormForUpdate

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

    • updatePoolConstrainer

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

    • canDeletePoolConstrainers

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

    • deletePoolConstrainer

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

    • canManagePoolConstrainerAliases

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

    • aliasPoolConstrainer

      void aliasPoolConstrainer(Id poolConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a PoolConstrainer for the purpose of creating compatibility. The primary Id of the PoolConstrainer 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 constrainer, it is reassigned to the given pool constrainer Id .
      Parameters:
      poolConstrainerId - the Id of a PoolConstrainer
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - poolConstrainerId not found
      NullArgumentException - poolConstrainerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.