Package hudson.model

Interface TopLevelItem

All Superinterfaces:

AccessControlled, Describable<TopLevelItem>, ExtensionPoint, FullyNamed, FullyNamedModelObject, Item, ModelObject, Named, OnMaster, PersistenceRoot, Saveable, SearchableModelObject, SearchItem

All Known Implementing Classes:

AbstractTopLevelItem, FreeStyleProject

public interface TopLevelItem
extends Item, ExtensionPoint, Describable<TopLevelItem>

Item that can be directly displayed under Jenkins or other containers. (A "container" would be any ItemGroup<TopLevelItem>, such as a folder of projects.) Ones that don't need to be under specific parent (say, unlike MatrixConfiguration), and thus can be freely moved, copied, etc.

To register a custom TopLevelItem class from a plugin, put Extension on your TopLevelItemDescriptor. Also see Items.XSTREAM.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.model.Item

BUILD, CANCEL, CONFIGURE, CREATE, DELETE, DISCOVER, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Modifier and Type	Method	Description
TopLevelItemDescriptor	getDescriptor()	Gets the descriptor for this instance.

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, getACL, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface jenkins.model.FullyNamedModelObject

getFullDisplayName

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getSearchGroup, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, onLoad, save

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIcon, getSearchIndex, getSearchName, getSearchUrl

Method Details

getDescriptor

TopLevelItemDescriptor getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<TopLevelItem>

See Also:

• Describable.getDescriptor()