Interface DispatchConstrainerEnablerLookupSession

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

This session provides methods for retrieving DispatchConstrainerEnablers .

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

    • canLookupDispatchConstrainerEnablers

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

    • useComparativeDispatchConstrainerEnablerView

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

    • usePlenaryDispatchConstrainerEnablerView

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

    • getDispatchConstrainerEnabler

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

    • getDispatchConstrainerEnablersByIds

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

    • getDispatchConstrainerEnablersByGenusType

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

    • getDispatchConstrainerEnablersByParentGenusType

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

    • getDispatchConstrainerEnablersByRecordType

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

    • getDispatchConstrainerEnablers

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