/hudson-core/src/main/java/hudson/model/ProminentProjectAction.java

http://github.com/hudson/hudson · Java · 47 lines · 6 code · 2 blank · 39 comment · 0 complexity · 1d5e251860de9f7fee664eddb17d011c 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.model;
  25. import hudson.tasks.BuildStep;
  26. import hudson.tasks.BuildWrapper;
  27. import hudson.triggers.Trigger;
  28. /**
  29. * Marker interface for {@link Action}s that should be displayed
  30. * at the top of the project page.
  31. *
  32. * {@link #getIconFileName()}, {@link #getUrlName()}, {@link #getDisplayName()}
  33. * are used to create a large, more visible icon in the top page to draw
  34. * users' attention.
  35. *
  36. * @see BuildStep#getProjectActions(AbstractProject)
  37. * @see BuildWrapper#getProjectActions(AbstractProject)
  38. * @see Trigger#getProjectActions()
  39. * @see JobProperty#getJobActions(Job)
  40. *
  41. * @author Kohsuke Kawaguchi
  42. */
  43. public interface ProminentProjectAction extends Action {
  44. // TODO: do the rendering of the part from the action page
  45. }