Package hudson.search

Interface SearchItem

All Known Subinterfaces:

BuildableItem, BuildableItemWithBuildWrappers, Item, ParameterizedJobMixIn.ParameterizedJob<JobT,RunT>, SCMedItem, SearchableModelObject, TopLevelItem, TriggeredItem

All Known Implementing Classes:

AbstractBuild, AbstractCIBase, AbstractCloudComputer, AbstractCloudImpl, AbstractCloudSlave, AbstractItem, AbstractModelObject, AbstractProject, AbstractScmTagAction, AbstractTopLevelItem, Actionable, AdministrativeError, AdministrativeMonitor, AllView, Api, ApiTokenPropertyDisabledDefaultAdministrativeMonitor, ApiTokenPropertyEnabledNewLegacyAdministrativeMonitor, AsynchronousAdministrativeMonitor, Build, BuiltInNodeMigration, Cloud, CompletedInitializationMonitor, Computer, ComputerSet, ControllerExecutorsAgents, ControllerExecutorsNoAgents, CrumbIssuer.RestrictedApi, CSRFAdministrativeMonitor, DumbSlave, FreeStyleBuild, FreeStyleProject, HsErrPidList, Hudson, Hudson.MasterComputer, HudsonHomeDiskUsageMonitor, HudsonHomeDiskUsageMonitor.Solution, JavaVersionRecommendationAdminMonitor, Jenkins, Jenkins.EnforceSlaveAgentPortAdministrativeMonitor, Jenkins.MasterComputer, Job, Label, LabelAtom, LabelExpression, LabelExpression.And, LabelExpression.Binary, LabelExpression.Iff, LabelExpression.Implies, LabelExpression.Not, LabelExpression.Or, LabelExpression.Paren, LegacyApiTokenAdministrativeMonitor, ListView, LocalPluginManager, LogRecorder, LogRecorderManager, MonitorMarkedNodeOffline, MyView, Node, NullIdDescriptorMonitor, OldDataMonitor, OperatingSystemEndOfLifeAdminMonitor, PluginManager, PluginManager.PluginCycleDependenciesMonitor, PluginManager.PluginDeprecationMonitor, PluginManager.PluginUpdateMonitor, PluginWrapper.PluginWrapperAdministrativeMonitor, Project, ProxyView, Queue.BlockedItem, Queue.BuildableItem, Queue.Item, Queue.LeftItem, Queue.NotWaitingItem, Queue.WaitingItem, RekeySecretAdminMonitor, ResourceDomainRecommendation, ReverseProxySetupMonitor, RootUrlNotSetMonitor, Run, SCMTrigger.AdministrativeMonitorImpl, SecurityIsOffMonitor, Slave, SlaveComputer, SlowTriggerAdminMonitor, TaskAction, TooManyJobsButNoView, UpdateCenter, UpdateCenter.CoreUpdateMonitor, UpdateSiteWarningsMonitor, URICheckEncodingMonitor, User, View, ViewJob

public interface SearchItem

Represents an item reachable from SearchIndex.

The act of searching in this package is really a traversal of a directed graph. And in that notion, this interface represents an edge, not a node. So it's possible for single entity (let's say Build) to have multiple SearchItems representing it (for example, a 'last successful build' search item and '#123' search item.)

Author:

Kohsuke Kawaguchi

Method Summary

Modifier and Type	Method	Description
SearchIndex	getSearchIndex()	Returns the SearchIndex to further search sub items inside this item.
String	getSearchName()	Name of this item.
String	getSearchUrl()	Returns the URL of this item relative to the parent SearchItem.

Method Detail

getSearchName

String getSearchName()

Name of this item. This is matched against the query.

getSearchUrl

String getSearchUrl()

Returns the URL of this item relative to the parent SearchItem.

Returns:

URL like "foo" or "foo/bar". The path can end with '/'. The path that starts with '/' will be interpreted as the absolute path (within the context path of Jenkins.)

getSearchIndex

SearchIndex getSearchIndex()

Returns the SearchIndex to further search sub items inside this item.

Returns:

SearchIndex.EMPTY if this is a leaf.

See Also:

SearchIndexBuilder