Interface PoolProcessorEnablerLookupSession

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

This session provides methods for retrieving PoolProcessorEnablers .

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 distributor view: All pool processor enabler methods in this session operate, retrieve and pertain to pool processor enablers defined explicitly in the current distributor Using an isolated view is useful for managing PoolProcessorEnablers with the PoolProcessorEnablerAdminSession .
  • federated distributor view: All pool processor enabler methods in this session operate, retrieve and pertain to all pool processor enablers defined in this distributor and any other pool processor enablers implicitly available in this distributor through distributor inheritence.

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() be have as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canLookupPoolProcessorEnablers

      boolean canLookupPoolProcessorEnablers()
      Tests if this user can perform PoolProcessorEnabler 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.

    • useComparativePoolProcessorEnablerView

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

    • usePlenaryPoolProcessorEnablerView

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

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include pool processor enablers in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

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

    • useActivePoolProcessorEnablerView

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

    • useAnyStatusPoolProcessorEnablerView

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

    • getPoolProcessorEnabler

      PoolProcessorEnabler getPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the PoolProcessorEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned PoolProcessorEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a PoolProcessorEnabler and retai ned for compatibility.
      Parameters:
      poolProcessorEnablerId - Id of the PoolProcessorEnabler
      Returns:
      the pool processor enabler
      Throws:
      NotFoundException - poolProcessorEnablerId not found
      NullArgumentException - poolProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getPoolProcessorEnablersByIds

      PoolProcessorEnablerList getPoolProcessorEnablersByIds(IdList poolProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the pool processor 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 PoolProcessorEnablers may be omi tted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      poolProcessorEnablerIds - the list of Ids to retrieve
      Returns:
      the returned PoolProcessorEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - poolProcessorEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablersByGenusType

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

    • getPoolProcessorEnablersByParentGenusType

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

    • getPoolProcessorEnablersByRecordType

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

    • getPoolProcessorEnablersOnDate

      PoolProcessorEnablerList getPoolProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorEnablerList that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known poolProcessorEnablers or an error results. Otherwise, the returned list may contain only those poolProcessorEnablers that are accessible through this session. In active mode, poolProcessorEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive poolProcessorEnablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned PoolProcessorEnabler 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.

    • getPoolProcessorEnablersOnDateWithAgent

      PoolProcessorEnablerList getPoolProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known poolProcessorEnablers or an error results. Otherwise, the returned list may contain only those poolProcessorEnablers that are accessible through this session. In active mode, poolProcessorEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive poolProcessorEnablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned PoolProcessorEnabler 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.

    • getPoolProcessorEnablers

      PoolProcessorEnablerList getPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all PoolProcessorEnablers . In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session.
      Returns:
      a list of PoolProcessorEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.