View Javadoc

1   /*
2    * Copyright (c) 2003 by Atlassian Software Systems Pty. Ltd.
3    * All rights reserved.
4    */
5   package com.atlassian.bonnie;
6   
7   import java.util.Collection;
8   
9   
10  /**
11   * Methods required by the indexing subsystem in order to properly handle object searching.
12   */
13  public interface Searchable
14  {
15      long getId();
16  
17      /**
18       * When we un-index something (say, a page), we also need to un-index everything
19       * contained within that page (comments, attachments), because presumably they're
20       * all about to go away.
21       */ 
22      Collection getSearchableDependants();
23  
24      /**
25       * Allows an object to tell the search indexer that it is not allowed to be indexed
26       */
27      boolean isIndexable();
28  }