Interface PublisherLookupSession

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

This session provides methods for retrieving Publishers . The Publisher represents a collection of disptches and subscriptions.

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

  • Method Details

    • canLookupPublishers

      boolean canLookupPublishers()
      Tests if this user can perform Publisher 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativePublisherView

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

    • usePlenaryPublisherView

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

    • getPublisher

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

    • getPublishersByIds

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

    • getPublishersByGenusType

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

    • getPublishersByParentGenusType

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

    • getPublishersByRecordType

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

    • getPublishersByProvider

      PublisherList getPublishersByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a PublisherList from the given provider. In plenary mode, the returned list contains all known publishers or an error results. Otherwise, the returned list may contain only those publishers that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Publisher list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPublishers

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