Interface ValueEnablerLookupSession

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

This session provides methods for retrieving ValueEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated configuration view: All value enabler methods in this session operate, retrieve and pertain to value enablers defined explicitly in the current configuration. Using an isolated view is useful for managing ValueEnablers with the ValueEnablerAdminSession .
  • federated configuration view: All value enabler methods in this session operate, retrieve and pertain to all value enablers defined in this configuration and any other value enablers implicitly available in this configuration through configuration inheritence.
  • active value enabler view: All value enabler lookup methods return active value enablers.
  • any status value enabler view: value enablers of any active and insatcive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • 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.

    • canLookupValueEnablers

      boolean canLookupValueEnablers()
      Tests if this user can perform ValueEnablers 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 opt not to offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeValueEnablerView

      void useComparativeValueEnablerView()
      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.

    • usePlenaryValueEnablerView

      void usePlenaryValueEnablerView()
      A complete view of the ValueEnabler 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.

    • useFederatedConfigurationView

      void useFederatedConfigurationView()
      Federates the view for methods in this session. A federated view will include value enablers in configurations which are children of this configuration in the configuration hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedConfigurationView

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

    • useActiveValueEnablerView

      void useActiveValueEnablerView()
      Only active value enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusValueEnablerView

      void useAnyStatusValueEnablerView()
      All active and inactive value enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getValueEnabler

      ValueEnabler getValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ValueEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ValueEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a ValueEnabler and retained for compatibility. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Parameters:
      valueEnablerId - Id of the ValueEnabler
      Returns:
      the value enabler
      Throws:
      NotFoundException - valueEnablerId not found
      NullArgumentException - valueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getValueEnablersByIds

      ValueEnablerList getValueEnablersByIds(IdList valueEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ValueEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the value enablers 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 ValueEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Parameters:
      valueEnablerIds - the list of Ids to retrieve
      Returns:
      the returned ValueEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - valueEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersByGenusType

      ValueEnablerList getValueEnablersByGenusType(Type valueEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ValueEnablerList corresponding to the given value enabler genus Type which does not include value enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Parameters:
      valueEnablerGenusType - a value enabler genus type
      Returns:
      the returned ValueEnabler list
      Throws:
      NullArgumentException - valueEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersByParentGenusType

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

    • getValueEnablersByRecordType

      ValueEnablerList getValueEnablersByRecordType(Type valueEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ValueEnablerList containing the given value enabler record Type . In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Parameters:
      valueEnablerRecordType - a value enabler record type
      Returns:
      the returned ValueEnabler list
      Throws:
      NullArgumentException - valueEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersOnDate

      ValueEnablerList getValueEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a ValueEnablerList effective within the given date range which are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned ValueEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablersOnDateWithAgent

      ValueEnablerList getValueEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a ValueEnablerList effective within the given date range which are effective for the entire given date range inclusive but not confined to the date range and evaluated for the given agent. In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned ValueEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getValueEnablers

      ValueEnablerList getValueEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all ValueEnablers . In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
      Returns:
      the returned ValueEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.