Interface ProvisionableEnablerDistributorAssignmentSession

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

This session provides methods to re-assign ProvisionableEnabler to Distributor mappings. A ProvisionableEnabler may appear in multiple Distributor catalogs and removing the last reference to a ProvisionableEnabler is the equivalent of deleting it. Each Distributor may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a ProvisionableEnabler to another Distributor is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignProvisionableEnablers

      boolean canAssignProvisionableEnablers()
      Tests if this user can alter provisionable enabler/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignProvisionableEnablerToDistributor

      boolean canAssignProvisionableEnablerToDistributor(Id distributorId)
      Tests if this user can alter provisionable enabler/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      distributorId - the Id of the Distributor
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - distributorId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableDistributorIds

      IdList getAssignableDistributorIds(Id distributorId) throws OperationFailedException
      Gets a list of distributors including and under the given distributor node in which any provisionable enabler can be assigned.
      Parameters:
      distributorId - the Id of the Distributor
      Returns:
      list of assignable distributor Ids
      Throws:
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableDistributorIdsForProvisionableEnabler

      IdList getAssignableDistributorIdsForProvisionableEnabler(Id distributorId, Id provisionableEnablerId) throws OperationFailedException
      Gets a list of distributors including and under the given distributor node in which a specific provisionable enabler can be assigned.
      Parameters:
      distributorId - the Id of the Distributor
      provisionableEnablerId - the Id of the ProvisionableEnabler
      Returns:
      list of assignable distributor Ids
      Throws:
      NullArgumentException - distributorId or provisionableEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignProvisionableEnablerToDistributor

      void assignProvisionableEnablerToDistributor(Id provisionableEnablerId, Id distributorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing ProvisionableEnabler to a Distributor .
      Parameters:
      provisionableEnablerId - the Id of the ProvisionableEnabler
      distributorId - the Id of the Distributor
      Throws:
      AlreadyExistsException - provisionableEnablerId is already assigned to distributorId
      NotFoundException - provisionableEnablerId or distributorId not found
      NullArgumentException - provisionableEnablerId or distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignProvisionableEnablerFromDistributor

      void unassignProvisionableEnablerFromDistributor(Id provisionableEnablerId, Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a ProvisionableEnabler from a Distributor .
      Parameters:
      provisionableEnablerId - the Id of the ProvisionableEnabler
      distributorId - the Id of the Distributor
      Throws:
      NotFoundException - provisionableEnablerId or distributorId not found or provisionableEnablerId not assigned to distributorId
      NullArgumentException - provisionableEnablerId or distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignProvisionableEnablerToDistributor

      void reassignProvisionableEnablerToDistributor(Id provisionableEnablerId, Id fromDistributorId, Id toDistributorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a ProvisionableEnabler from one Distributor to another. Mappings to other Distributors are unaffected.
      Parameters:
      provisionableEnablerId - the Id of the ProvisionableEnabler
      fromDistributorId - the Id of the current Distributor
      toDistributorId - the Id of the destination Distributor
      Throws:
      AlreadyExistsException - provisionableEnablerId already assigned to toDistributorId
      NotFoundException - provisionableEnablerId, fromDistributorId , or toDistributorId not found or provisionableEnablerId not mapped to fromDistributorId
      NullArgumentException - provisionableEnablerId, fromDistributorId , or toDistributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.