Interface TextLookupSession

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

This session provides methods for retrieving Text objects. The Text represents a fixed connection between two Texts .

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 text methods in this session operate, retrieve and pertain to texts defined explicitly in the current press. Using an isolated view is useful for managing Texts with the TextAdminSession .
  • federated press view: All text methods in this session operate, retrieve and pertain to all texts defined in this press and any other texts 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.

    • canLookupTexts

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

    • useComparativeTextView

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

    • usePlenaryTextView

      void usePlenaryTextView()
      A complete view of the Text 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 texts 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.

    • getText

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

    • getTextsByIds

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

    • getTextsByGenusType

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

    • getTextsByParentGenusType

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

    • getTextsByRecordType

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

    • getTexts

      TextList getTexts() throws OperationFailedException, PermissionDeniedException
      Gets all Texts . In plenary mode, the returned list contains all known texts or an error results. Otherwise, the returned list may contain only those texts that are accessible through this session. In effective mode, texts are returned that are currently effective. In any effective mode, effective texts and those currently expired are returned.
      Returns:
      a list of Texts
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.