Package com.github.cc007.headsplugin.api.business.services.heads

Interface HeadSearcher

public interface HeadSearcher

  • Method Details

    • getSearchCount

      long getSearchCount(String searchTerm)
      Get the number of times a certain search term is used.
      Parameters:
      searchTerm - the search term
      Returns:
      the number of times the search term is used
      Throws:
      LockingException - when the current thread is unable to obtain the lock for starting a transaction

    • getHead

      Optional<Head> getHead(UUID headOwner)
      Get the Head for the provided head owner UUID, as Optional
      Parameters:
      headOwner - the head owner UUID
      Returns:
      the optional head
      Throws:
      LockingException - when the current thread is unable to obtain the lock for starting a transaction

    • getHeads

      List<Head> getHeads(String searchTerm)
      Get all Heads for a given search term. This method will also update the cached heads for the search term if necessary.
      Parameters:
      searchTerm - the search term to use when searching for heads
      Returns:
      a list of all heads that match the search term.
      Throws:
      LockingException - when the current thread is unable to obtain the lock for starting a transaction