com.synopsys.arc.jenkinsci.plugins.dynamic_search.views

Class SimpleSearchView

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.View

hudson.model.ListView

com.synopsys.arc.jenkinsci.plugins.dynamic_search.views.SimpleSearchView

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.View>, hudson.model.ModelObject, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled

public class SimpleSearchView
extends hudson.model.ListView

List View with dynamic filters. Class uses internal storage to pass parameters between pages.

Author:

Oleg Nenashev , Synopsys Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleSearchView.DescriptorImpl

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

hudson.model.View.AsynchPeople, hudson.model.View.People, hudson.model.View.PropertyList, hudson.model.View.UserInfo

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.util.VersionNumber	MINIMAL_AUTOREFRESH_VERSION A minimal version, where views can disable the automatic refresh.

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

Constructors

Constructor and Description
SimpleSearchView(String name)

Method Summary

Methods

Modifier and Type	Method and Description
String	cleanCache() Cleans internal cache of JSON Objects for the session.
void	doSearchSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
JobsFilter	getDefaultFilters() Gets default search options for UI.
String	getDefaultIncludeRegex()
hudson.util.DescribableList<hudson.views.ViewJobFilter,hudson.model.Descriptor<hudson.views.ViewJobFilter>>	getDefaultJobFilters()
JobsFilter	getFilters() Retrieves view filters for the user.
List<hudson.model.TopLevelItem>	getItems()
hudson.search.Search	getSearch()
static String	getSessionId() Gets identifier of the current session.
boolean	hasConfiguredFilters()
boolean	hasUserJobFilterExtensions()
boolean	isAutomaticRefreshEnabled() An override for future versions (since 1.557).
protected void	submit(org.kohsuke.stapler.StaplerRequest req)
void	updateSearchCache(JobsFilter filter)

Methods inherited from class hudson.model.ListView

add, contains, doAddJobToView, doCreateItem, doRemoveJobFromView, getColumns, getDefaultColumns, getIncludeRegex, getJobFilters, getStatusFilter, hasJobFilterExtensions, initColumns, initJobFilters, onJobRenamed

Methods inherited from class hudson.model.View

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

Methods inherited from class hudson.model.AbstractModelObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Saveable

save

Field Detail

MINIMAL_AUTOREFRESH_VERSION

public static final hudson.util.VersionNumber MINIMAL_AUTOREFRESH_VERSION

A minimal version, where views can disable the automatic refresh.

Since:

0.2.1

Constructor Detail

SimpleSearchView

@DataBoundConstructor
public SimpleSearchView(String name)

Method Detail

getDefaultIncludeRegex

public String getDefaultIncludeRegex()

getDefaultJobFilters

public hudson.util.DescribableList<hudson.views.ViewJobFilter,hudson.model.Descriptor<hudson.views.ViewJobFilter>> getDefaultJobFilters()

submit

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

Overrides:

submit in class hudson.model.ListView

Throws:

javax.servlet.ServletException

hudson.model.Descriptor.FormException

IOException

getSessionId

public static String getSessionId()

Gets identifier of the current session.

Returns:

Unique id of the current session.

getSearch

public hudson.search.Search getSearch()

Specified by:

getSearch in interface hudson.search.SearchableModelObject

Overrides:

getSearch in class hudson.model.AbstractModelObject

hasConfiguredFilters

public boolean hasConfiguredFilters()

getFilters

public JobsFilter getFilters()

Retrieves view filters for the user.

Returns:

View filters from the session if it is available. Otherwise, default filters will be returned.

getDefaultFilters

@Nonnull
public JobsFilter getDefaultFilters()

Gets default search options for UI.

Returns:

a default set of filters.

Since:

0.2

isAutomaticRefreshEnabled

public boolean isAutomaticRefreshEnabled()

An override for future versions (since 1.557).

Returns:

Always false

cleanCache

public String cleanCache()

Cleans internal cache of JSON Objects for the session.

Returns:

Current Session Id

getItems

public List<hudson.model.TopLevelItem> getItems()

Overrides:

getItems in class hudson.model.ListView

doSearchSubmit

public void doSearchSubmit(org.kohsuke.stapler.StaplerRequest req,
                  org.kohsuke.stapler.StaplerResponse rsp)
                    throws IOException,
                           UnsupportedEncodingException,
                           javax.servlet.ServletException,
                           hudson.model.Descriptor.FormException

Throws:

IOException

UnsupportedEncodingException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

updateSearchCache

public void updateSearchCache(JobsFilter filter)

hasUserJobFilterExtensions

public boolean hasUserJobFilterExtensions()