Interface PoolConstrainerEnablerLookupSession

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

This session provides methods for retrieving PoolConstrainerEnablers .

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 cosntrainer enabler methods in this session operate, retrieve and pertain to pool constrainer enablers defined explicitly in the current distributor Using an isolated view is useful for managing PoolConstrainerEnablers with the PoolConstrainerEnablerAdminSession .
  • federated distributor view: All pool constrainer enabler methods in this session operate, retrieve and pertain to all pool constrainer enablers defined in this distributor and any other pool constrainer 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.

    • canLookupPoolConstrainerEnablers

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

    • useComparativePoolConstrainerEnablerView

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

    • usePlenaryPoolConstrainerEnablerView

      void usePlenaryPoolConstrainerEnablerView()
      A complete view of the PoolConstrainerEnabler 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 constrainer 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.

    • useActivePoolConstrainerEnablerView

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

    • useAnyStatusPoolConstrainerEnablerView

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

    • getPoolConstrainerEnabler

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

    • getPoolConstrainerEnablersByIds

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

    • getPoolConstrainerEnablersByGenusType

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

    • getPoolConstrainerEnablersByParentGenusType

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

    • getPoolConstrainerEnablersByRecordType

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

    • getPoolConstrainerEnablersOnDate

      PoolConstrainerEnablerList getPoolConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PoolConstrainerEnablerList 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 poolConstrainerEnablers or an error results. Otherwise, the returned list may contain only those poolConstrainerEnablers that are accessible through this session. In active mode, poolConstrainerEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive poolConstrainerEnablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned PoolConstrainerEnabler 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.

    • getPoolConstrainerEnablersOnDateWithAgent

      PoolConstrainerEnablerList getPoolConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PoolConstrainerEnablerList 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 poolConstrainerEnablers or an error results. Otherwise, the returned list may contain only those poolConstrainerEnablers that are accessible through this session. In active mode, poolConstrainerEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive poolConstrainerEnablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned PoolConstrainerEnabler 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.

    • getPoolConstrainerEnablers

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