Interface DispatchConstrainerLookupSession

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

This session provides methods for retrieving DispatchConstrainers .

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

    • canLookupDispatchConstrainers

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

    • useComparativeDispatchConstrainerView

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

    • usePlenaryDispatchConstrainerView

      void usePlenaryDispatchConstrainerView()
      A complete view of the DispatchConstrainer 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 constrainers 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.

    • getDispatchConstrainer

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

    • getDispatchConstrainersByIds

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

    • getDispatchConstrainersByGenusType

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

    • getDispatchConstrainersByParentGenusType

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

    • getDispatchConstrainersByRecordType

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

    • getDispatchConstrainers

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