Interface SnIndexService

  • All Known Implementing Classes:
    DefaultSnIndexService

    public interface SnIndexService
    Service for index related functionality.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void deleteIndexForId​(java.lang.String indexTypeId, java.lang.String indexId)
      Deletes the index with the given id.
      java.lang.String getDefaultIndexId​(java.lang.String indexTypeId)
      Returns the default index id for the given index type id.
    • Method Detail

      • getDefaultIndexId

        java.lang.String getDefaultIndexId​(java.lang.String indexTypeId)
                                    throws SnIndexException
        Returns the default index id for the given index type id. The index might not yet exist on the target system.
        Parameters:
        indexTypeId - - the index type id
        Returns:
        the default index id
        Throws:
        SnIndexException - if an error occurs
      • deleteIndexForId

        void deleteIndexForId​(java.lang.String indexTypeId,
                              java.lang.String indexId)
                       throws SnIndexException
        Deletes the index with the given id.
        Parameters:
        indexTypeId - - the index type id
        indexId - - the index id
        Throws:
        SnIndexException - if an error occurs