Interface IdiomLookupSession

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

This session provides methods for retrieving Idioms . The Idiom represents a fixed connection between two Affiliations .

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 press view: All idiom methods in this session operate, retrieve and pertain to idioms defined explicitly in the current press. Using an isolated view is useful for managing Idioms with the IdiomAdminSession .
  • federated press view: All idiom methods in this session operate, retrieve and pertain to all idioms defined in this press and any other idioms implicitly available in this press through press inheritence.

Generally, the comparative view should be used for most presses as it permits operation even if there is data that cannot be accessed. The methods useFederatedPressView() and useIsolatedPressView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getPressId

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

    • getPress

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

    • canLookupIdioms

      boolean canLookupIdioms()
      Tests if this user can perform Idiom 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 press 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.

    • useComparativeIdiomView

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

    • usePlenaryIdiomView

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

    • useFederatedPressView

      void useFederatedPressView()
      Federates the view for methods in this session. A federated view will include idioms in presses which are children of this press in the press hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPressView

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

    • getIdiom

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

    • getIdiomsByIds

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

    • getIdiomsByGenusType

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

    • getIdiomsByParentGenusType

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

    • getIdiomsByRecordType

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

    • getIdiomsForText

      IdiomList getIdiomsForText(Id textId) throws OperationFailedException, PermissionDeniedException
      Gets an IdiomList by text. In plenary mode, the returned list contains all known idioms or an error results. Otherwise, the returned list may contain only those idioms that are accessible through this session.
      Parameters:
      textId - a text Id
      Returns:
      the returned Idiom list
      Throws:
      NullArgumentException - textId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIdioms

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