Interface DispatchProcessorEnablerLookupSession

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

This session provides methods for retrieving DispatchProcessorEnablers .

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 publisher view: All dispatch processor enabler methods in this session operate, retrieve and pertain to dispatch processor enablers defined explicitly in the current publisher Using an isolated view is useful for managing DispatchProcessorEnablers with the DispatchProcessorEnablerAdminSession .
  • federated publisher view: All dispatch processor enabler methods in this session operate, retrieve and pertain to all dispatch processor enablers defined in this publisher and any other dispatch processor enablers implicitly available in this publisher through publisher 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 useFederatedPublisherView() and useIsolatedPublisherView() beha ve as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getPublisherId

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

    • getPublisher

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

    • canLookupDispatchProcessorEnablers

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

    • useComparativeDispatchProcessorEnablerView

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

    • usePlenaryDispatchProcessorEnablerView

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

    • useFederatedPublisherView

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

    • useIsolatedPublisherView

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

    • getDispatchProcessorEnabler

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

    • getDispatchProcessorEnablersByIds

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

    • getDispatchProcessorEnablersByGenusType

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

    • getDispatchProcessorEnablersByParentGenusType

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

    • getDispatchProcessorEnablersByRecordType

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

    • getDispatchProcessorEnablers

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