hudson.model
Class AllView

java.lang.Object
  hudson.model.AbstractModelObject
      hudson.model.View
          hudson.model.AllView

All Implemented Interfaces:

ExtensionPoint, Describable<View>, ModelObject, Saveable, SearchableModelObject, SearchItem, AccessControlled

public class AllView
extends View

View that contains everything.

Since:

1.269

Author:

Kohsuke Kawaguchi

Nested Class Summary

static class

AllView.DescriptorImpl

Nested classes/interfaces inherited from class hudson.model.View

View.AsynchPeople, View.People, View.PropertyList, View.UserInfo

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.View

CONFIGURE, CREATE, DELETE, description, filterExecutors, filterQueue, LIST, name, NEW_PRONOUN, owner, PERMISSIONS, READ, SORTER, transientActions

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

AllView(String name)

AllView(String name, ViewGroup owner)

Method Summary

boolean	contains(TopLevelItem item) Checks if the job is in this collection.
Item	doCreateItem(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Creates a new Item in this collection.
void	doSubmitDescription(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Accepts the new description.
String	getDescription() Message displayed in the top page.
Collection<TopLevelItem>	getItems() Gets all the items in this collection in a read-only view.
String	getPostConstructLandingPage() Returns the page to redirect the user to, after the view is created.
boolean	isEditable() By default, return true to render the "Edit view" link on the page.
void	onJobRenamed(Item item, String oldName, String newName) Called when a job name is changed or deleted.
protected void	submit(org.kohsuke.stapler.StaplerRequest req) Handles the configuration submission.

Methods inherited from class hudson.model.View

all, allInstantiable, checkPermission, create, createViewFromXML, doConfigDotXml, doConfigSubmit, doDoDelete, doRssAll, doRssFailed, doRssLatest, getAbsoluteUrl, getACL, getActions, getAllProperties, getApi, getApplicablePropertyDescriptors, getApproximateQueueItemsQuickly, getAsynchPeople, getBuilds, getColumns, getComputers, getDescriptor, getDisplayName, getDynamic, getIndenter, getItem, getItemCreatePermission, getJob, getNewPronoun, getOwner, getOwnerItemGroup, getOwnerPrimaryView, getOwnerViewActions, getPeople, getProperties, getQueueItems, getSearchUrl, getTimeline, getUrl, getViewName, getViewUrl, getWidgets, hasPeople, hasPermission, isDefault, isFilterExecutors, isFilterQueue, makeSearchIndex, rename, save, toString, updateByXml, updateTransientActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AllView

@DataBoundConstructor
public AllView(String name)

AllView

public AllView(String name,
               ViewGroup owner)

Method Detail

getDescription

public String getDescription()

Description copied from class: View

Message displayed in the top page. Can be null. Includes HTML.

Overrides:

getDescription in class View

isEditable

public boolean isEditable()

Description copied from class: View

By default, return true to render the "Edit view" link on the page. This method is really just for the default "All" view to hide the edit link so that the default Hudson top page remains the same as before 1.316.

Overrides:

isEditable in class View

contains

public boolean contains(TopLevelItem item)

Description copied from class: View

Checks if the job is in this collection.

Specified by:

contains in class View

doCreateItem

public Item doCreateItem(org.kohsuke.stapler.StaplerRequest req,
                         org.kohsuke.stapler.StaplerResponse rsp)
                  throws IOException,
                         javax.servlet.ServletException

Description copied from class: View

Creates a new Item in this collection.

This method should call ModifiableItemGroup.doCreateItem(StaplerRequest, StaplerResponse) and then add the newly created item to this view.

Specified by:

doCreateItem in class View

Returns:

null if fails.

Throws:

IOException

javax.servlet.ServletException

getItems

public Collection<TopLevelItem> getItems()

Description copied from class: View

Gets all the items in this collection in a read-only view.

Specified by:

getItems in class View

doSubmitDescription

public void doSubmitDescription(org.kohsuke.stapler.StaplerRequest req,
                                org.kohsuke.stapler.StaplerResponse rsp)
                         throws IOException,
                                javax.servlet.ServletException

Description copied from class: View

Accepts the new description.

Overrides:

doSubmitDescription in class View

Throws:

IOException

javax.servlet.ServletException

getPostConstructLandingPage

public String getPostConstructLandingPage()

Description copied from class: View

Returns the page to redirect the user to, after the view is created. The returned string is appended to "/view/foobar/", so for example to direct the user to the top page of the view, return "", etc.

Overrides:

getPostConstructLandingPage in class View

onJobRenamed

public void onJobRenamed(Item item,
                         String oldName,
                         String newName)

Description copied from class: View

Called when a job name is changed or deleted.

If this view contains this job, it should update the view membership so that the renamed job will remain in the view, and the deleted job is removed.

Specified by:

onJobRenamed in class View

Parameters:

item - The item whose name is being changed.

oldName - Old name of the item. Always non-null.

newName - New name of the item, if the item is renamed. Or null, if the item is removed.

submit

protected void submit(org.kohsuke.stapler.StaplerRequest req)
               throws IOException,
                      javax.servlet.ServletException,
                      Descriptor.FormException

Description copied from class: View

Handles the configuration submission. Load view-specific properties here.

Specified by:

submit in class View

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException