Interface DispatchConstrainerEnablerRuleLookupSession

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

This session provides methods to retrieve DispatchConstrainerEnabler to DispatchConstrainer mappin gs.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated publisher view: All methods in this session operate, retrieve and pertain to dispatch constrainer enablers defined explicitly in the current publisher
  • federated publisher view: All 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.

  • 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.

    • canLookupDispatchConstrainerEnablerRules

      boolean canLookupDispatchConstrainerEnablerRules()
      Tests if this user can perform lookups of dispatch constrainer enabler/dispatch constrainer mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeDispatchConstrainerEnablerRuleView

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

    • usePlenaryDispatchConstrainerEnablerRuleView

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

    • getDispatchConstrainerEnablerIdsForDispatch

      IdList getDispatchConstrainerEnablerIdsForDispatch(Id dispatchConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchConstrainerEnablerIds associated with a DispatchConstrainer .
      Parameters:
      dispatchConstrainerId - Id of the DispatchConstrainer
      Returns:
      the dispatch constrainer enabler Ids
      Throws:
      NotFoundException - dispatchConstrainerId is not found
      NullArgumentException - dispatchConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainerEnablersForDispatchConstrainer

      DispatchConstrainerEnablerList getDispatchConstrainerEnablersForDispatchConstrainer(Id dispatchConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchConstrainerEnablers associated with a DispatchConstrainer .
      Parameters:
      dispatchConstrainerId - Id of the DispatchConstrainer
      Returns:
      the dispatch constrainer enablers
      Throws:
      NotFoundException - dispatchConstrainerId is not found
      NullArgumentException - dispatchConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainerIdsForDispatchConstrainerEnabler

      IdList getDispatchConstrainerIdsForDispatchConstrainerEnabler(Id dispatchConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchConstrainer Ids mapped to a DispatchConstrainerEnabler .
      Parameters:
      dispatchConstrainerEnablerId - Id of a DispatchConstrainerEnabler
      Returns:
      list of dispatch Ids
      Throws:
      NotFoundException - dispatchConstrainerEnablerId is not found
      NullArgumentException - dispatchConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainersForDispatchConstrainerEnabler

      DispatchConstrainerList getDispatchConstrainersForDispatchConstrainerEnabler(Id dispatchConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchConstrainers mapped to a DispatchConstrainerEnabler .
      Parameters:
      dispatchConstrainerEnablerId - Id of a DispatchConstrainerEnabler
      Returns:
      list of dispatch constrainers
      Throws:
      NotFoundException - dispatchConstrainerEnablerId is not found
      NullArgumentException - dispatchConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.