Package de.espirit.firstspirit.agency

Interface SearchIndexAgent

@NonExtendable public interface SearchIndexAgent
Definition of an agent offering capabilities to modify the settings for the search indexer.
Since:
5.2.1503

  • Field Details

    • RELATIONSHIP_PATH_LENGTH_TO_FOLLOW

      static final String RELATIONSHIP_PATH_LENGTH_TO_FOLLOW
      Name of the server wide property to define the maximum path length to follow on indexing relationships. Can be overwritten in the "fs-server.conf".
      Since:
      5.2.1503
      See Also:

    • TYPE

      static final SpecialistType<SearchIndexAgent> TYPE
      Technical type of an agent specialized for changing settings of the search indexer.
      Since:
      5.2.1503

  • Method Details

    • resetPathLengthToFollow

      void resetPathLengthToFollow() throws LockException
      Resets the project specific override for indexing.relationshipPathLengthToFollow. Consequently, the server wide setting will be used.
      Throws:
      LockException - if the project could not be locked
      Since:
      5.2.1503

    • getPathLengthToFollow

      int getPathLengthToFollow()
      Returns the currently set path length to follow on indexing relationships.
      Returns:
      the maximum path length to follow
      Since:
      5.2.1503

    • setPathLengthToFollow

      void setPathLengthToFollow(int pathLengthToFollow) throws LockException
      Sets the project specific value to override the server wide setting of indexing.relationshipPathLengthToFollow.
      Parameters:
      pathLengthToFollow - the maximum path length to follow
      Throws:
      LockException - if the project could not be locked
      Since:
      5.2.1503