Class TopLevelItem

All Implemented Interfaces:
Direct Known Subclasses:
Folder, Job

public abstract class TopLevelItem extends ContainerPageObject
Super class for top level items. Top level items include Jobs and other non-buildable items such as Folders. Use Describable annotation to register an implementation.
  • Field Details

  • Constructor Details

    • TopLevelItem

      public TopLevelItem( injector, URL url, String name)
    • TopLevelItem

      public TopLevelItem(PageObject context, URL url, String name)
  • Method Details

    • getParameters

      public List<Parameter> getParameters()
    • renameTo

      @CheckReturnValue public <T extends TopLevelItem> T renameTo(String newName)
      Renames the job. Opens the configuration section, sets the name and saves the form. Finally the rename is confirmed.
      newName - the new name of the job
      the renamed job (with new URL)
    • getDescription

      public String getDescription()
    • description

      public void description(String description, boolean withCodeMirror)
      Changes the description. Opens the configuration section, sets the description and saves the form.
      description - the description of the job
      withCodeMirror - if description field uses CodeMirror or not (depending on Markup Formatter)
    • setDescription

      public void setDescription(String description)
    • setDescription

      public void setDescription(String description, boolean withCodeMirror)
    • getDisplayName

      public String getDisplayName()
    • as

      public <T extends TopLevelItem> T as(Class<T> type)
      "Casts" this object into a subtype by creating the specified type.
    • toString

      public String toString()
      toString in class PageObject
    • equals

      public boolean equals(Object other)
      equals in class ContainerPageObject
    • hashCode

      public int hashCode()
      hashCode in class ContainerPageObject
    • delete

      public abstract void delete()