hudson.model
Interface TopLevelItem

All Superinterfaces:
AccessControlled, Describable<TopLevelItem>, ExtensionPoint, Item, ModelObject, PersistenceRoot, Saveable, SearchableModelObject, SearchItem
All Known Implementing Classes:
ExternalJob, FreeStyleProject, MatrixProject

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

Item that can be directly displayed under Hudson or other containers. 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, CONFIGURE, CREATE, DELETE, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE
 
Fields inherited from interface hudson.model.Saveable
NOOP
 
Method Summary
 TopLevelItemDescriptor getDescriptor()
          Gets the descriptor for this instance.
 
Methods inherited from interface hudson.model.Item
delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, 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
getSearchIndex, getSearchName, getSearchUrl
 
Methods inherited from interface hudson.security.AccessControlled
checkPermission, getACL, hasPermission
 

Method Detail

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 a.getDescriptor()==b.getDescriptor() must hold.

Specified by:
getDescriptor in interface Describable<TopLevelItem>
See Also:
Describable.getDescriptor()


Copyright © 2004-2013 Hudson. All Rights Reserved.