/hudson-core/src/main/java/hudson/search/SearchableModelObject.java

http://github.com/hudson/hudson · Java · 44 lines · 5 code · 2 blank · 37 comment · 0 complexity · 0583ad781f5b794d3a7c86fe0b68be7c MD5 · raw file

  1. /*
  2. * The MIT License
  3. *
  4. * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining a copy
  7. * of this software and associated documentation files (the "Software"), to deal
  8. * in the Software without restriction, including without limitation the rights
  9. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. * copies of the Software, and to permit persons to whom the Software is
  11. * furnished to do so, subject to the following conditions:
  12. *
  13. * The above copyright notice and this permission notice shall be included in
  14. * all copies or substantial portions of the Software.
  15. *
  16. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. * THE SOFTWARE.
  23. */
  24. package hudson.search;
  25. import hudson.model.ModelObject;
  26. /**
  27. * {@link ModelObject} that can be searched.
  28. *
  29. * <p>
  30. * This interface also extends {@link SearchItem} since
  31. * often {@link ModelObject}s form a natural tree structure,
  32. * and it's convenient for the model objects themselves to implement
  33. * the {@link SearchItem} for the edges that form this tree.
  34. *
  35. * @author Kohsuke Kawaguchi
  36. */
  37. public interface SearchableModelObject extends ModelObject, SearchItem {
  38. /**
  39. * This binds {@link Search} object to the URL hierarchy.
  40. */
  41. Search getSearch();
  42. }