Interface SettingLookupSession

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

This session defines methods for retrieving settings.

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
  • isolated system view: All setting methods in this session operate, retrieve and pertain to settings defined explicitly in the current system. Using an isolated view is useful for managing Settings with the SettingAdminSession .
  • federated system view: All setting lookup methods in this session operate, retrieve and pertain to all settings defined in this system and any other settings implicitly available in this system through system inheritence.

The methods useFederatedSystemView() and useIsolatedSystemView() behave as a radio group and one should be selected before invoking any lookup methods.

Settings may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the settings.

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canLookupSettings

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

    • useComparativeSettingView

      void useComparativeSettingView()
      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 is must be implemented.

    • usePlenarySettingView

      void usePlenarySettingView()
      A complete view of the Setting 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 is must be implemented.

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include settings in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

      void useIsolatedSystemView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this system only.
      Compliance:
      mandatory - This method is must be implemented.

    • getSetting

      Setting getSetting(Id settingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Setting specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Setting may have a different Id than requested, such as the case where a duplicate Id was assigned to a Setting and retained for compatibility.
      Parameters:
      settingId - the Id of the Setting to retrieve
      Returns:
      the returned Setting
      Throws:
      NotFoundException - no Setting found with the given Id
      NullArgumentException - settingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSettingsByIds

      SettingList getSettingsByIds(IdList settingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a SettingList corresponding to the given IdList . In plenary mode, the returned list contains all of the settings specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Settings may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      settingIds - the list of Ids to retrieve
      Returns:
      the returned Setting list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - settingIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSettingsByGenusType

      SettingList getSettingsByGenusType(Type settingGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a SettingList corresponding to the given setting genus Type which does not include settings of types derived from the specified Type . In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
      Parameters:
      settingGenusType - a setting genus type
      Returns:
      the returned Setting list
      Throws:
      NullArgumentException - settingGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSettingsByParentGenusType

      SettingList getSettingsByParentGenusType(Type settingGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a SettingList corresponding to the given setting genus Type and include any additional settings with genus types derived from the specified Type . In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
      Parameters:
      settingGenusType - a setting genus type
      Returns:
      the returned Setting list
      Throws:
      NullArgumentException - settingGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSettingsByRecordType

      SettingList getSettingsByRecordType(Type settingRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a SettingList containing the given setting record Type . In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
      Parameters:
      settingRecordType - a setting record type
      Returns:
      the returned Setting list
      Throws:
      NullArgumentException - settingRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSettingsForController

      SettingList getSettingsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Gets a list of settings for a controller. In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
      Parameters:
      controllerId - a controller Id
      Returns:
      the returned Setting list
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSettings

      SettingList getSettings() throws OperationFailedException, PermissionDeniedException
      Gets all settings. In plenary mode, the returned list contains all of the settings including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Settings may be omitted from the list and may present the elements in any order including returning a unique set.
      Returns:
      the returned Setting list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.