Interface ParameterProcessorEnablerAdminSession

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

This session creates and removes parameter processor enablers. The data for create and update is provided via the ParameterProcessorEnablerForm.

  • Method Details

    • getConfigurationId

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

    • getConfiguration

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

    • canCreateParameterProcessorEnabler

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

    • canCreateParameterProcessorEnablerWithRecordTypes

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

    • getParameterProcessorEnablerFormForCreate

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

    • createParameterProcessorEnabler

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

    • canUpdateParameterProcessorEnablers

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

    • getParameterProcessorEnablerFormForUpdate

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

    • updateParameterProcessorEnabler

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

    • canDeleteParameterProcessorEnablers

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

    • deleteParameterProcessorEnabler

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

    • canManageParameterProcessorEnablerAliases

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

    • aliasParameterProcessorEnabler

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