jenkins.model

Interface ModifiableTopLevelItemGroup

All Superinterfaces:

ItemGroup<TopLevelItem>, ModelObject, ModifiableItemGroup<TopLevelItem>, PersistenceRoot, Saveable

All Known Subinterfaces:

DirectlyModifiableTopLevelItemGroup

All Known Implementing Classes:

Hudson, Jenkins

public interface ModifiableTopLevelItemGroup
extends ModifiableItemGroup<TopLevelItem>

A ModifiableItemGroup to manage TopLevelItem, including copying, creating from descriptor and from XML.

Since:

1.480

Author:

Nicolas De Loof

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Modifier and Type	Method and Description
<T extends TopLevelItem> T	copy(T src, String name) Copys a job.
TopLevelItem	createProject(TopLevelItemDescriptor type, String name, boolean notify) Creates a new job.
TopLevelItem	createProjectFromXML(String name, InputStream xml) /** Creates a new job from its configuration XML.

Methods inherited from interface hudson.model.ModifiableItemGroup

doCreateItem

Methods inherited from interface hudson.model.ItemGroup

getFullDisplayName, getFullName, getItem, getItems, getRootDirFor, getUrl, getUrlChildPrefix, onDeleted, onRenamed

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.model.Saveable

save

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Method Detail

copy

<T extends TopLevelItem> T copy(T src,
                                String name)
                         throws IOException

Copys a job.

Parameters:

src - A TopLevelItem to be copied.

name - Name of the newly created project.

Returns:

Newly created TopLevelItem.

Throws:

IOException

createProjectFromXML

TopLevelItem createProjectFromXML(String name,
                                  InputStream xml)
                           throws IOException

/** Creates a new job from its configuration XML. The type of the job created will be determined by what's in this XML.

Parameters:

name - Name of the newly created project.

xml - Item configuration as xml

Returns:

Newly created TopLevelItem.

Throws:

IOException

createProject

TopLevelItem createProject(TopLevelItemDescriptor type,
                           String name,
                           boolean notify)
                    throws IOException

Creates a new job.

Parameters:

type - Descriptor for job type

name - Name for job

notify - Whether to fire onCreated method for all ItemListeners

Throws:

IllegalArgumentException - if a project of the give name already exists.

IOException