Interface ValueEnablerConfigurationSession

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

This session provides methods to retrieve ValueEnabler to Configuration mappings. A ValueEnabler may appear in multiple Configuration objects. Each configuration may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

Like all OsidSessions, ValueEnablerConfigurationSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • canLookupValueEnablerConfigurationMappings

      boolean canLookupValueEnablerConfigurationMappings()
      Tests if this user can perform lookups of value enabler/configuration mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeValueEnablerConfigurationView

      void useComparativeValueEnablerConfigurationView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method must be implemented.

    • usePlenaryValueEnablerConfigurationView

      void usePlenaryValueEnablerConfigurationView()
      A complete view of the ValueEnabler and Configuration returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablerIdsByConfiguration

      IdList getValueEnablerIdsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ValueEnablerIds associated with an Configuration.
      Parameters:
      configurationId - Id of the Configuration
      Returns:
      list of related value enabler Ids
      Throws:
      NotFoundException - configurationId is not found
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersByConfiguration

      ValueEnablerList getValueEnablersByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of value enablers associated with an Configuration.
      Parameters:
      configurationId - Id of the Configuration
      Returns:
      list of related value enablers
      Throws:
      NotFoundException - configurationId is not found
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablerIdsByConfigurations

      IdList getValueEnablerIdsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of ValueEnabler Ids corresponding to a list of Configurations.
      Parameters:
      configurationIds - list of configuration Ids
      Returns:
      list of value enabler Ids
      Throws:
      NullArgumentException - configurationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersByConfigurations

      ValueEnablerList getValueEnablersByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of value enablers corresponding to a list of Configurations.
      Parameters:
      configurationIds - list of configuration Ids
      Returns:
      list of value enablers
      Throws:
      NullArgumentException - configurationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getConfigurationIdsByValueEnabler

      IdList getConfigurationIdsByValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Configuration Ids mapped to a ValueEnabler.
      Parameters:
      valueEnablerId - Id of a ValueEnabler
      Returns:
      list of configurations
      Throws:
      NotFoundException - valueEnablerId is not found
      NullArgumentException - valueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getConfigurationsByValueEnabler

      ConfigurationList getConfigurationsByValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Configurations mapped to a ValueEnabler.
      Parameters:
      valueEnablerId - Id of a ValueEnabler
      Returns:
      list of configurations
      Throws:
      NotFoundException - valueEnablerId is not found
      NullArgumentException - valueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.