hudson.model
Interface ItemGroup<T extends Item>

All Superinterfaces:
ModelObject, PersistenceRoot, Saveable
All Known Subinterfaces:
ModifiableItemGroup<T>, ModifiableTopLevelItemGroup
All Known Implementing Classes:
AbstractCIBase, Hudson, Jenkins, MatrixProject, MavenModuleSet, MockFolder

public interface ItemGroup<T extends Item>
extends PersistenceRoot, ModelObject

Represents a grouping inherent to a kind of Items.

Author:
Kohsuke Kawaguchi
See Also:
ItemGroupMixIn

Field Summary
 
Fields inherited from interface hudson.model.Saveable
NOOP
 
Method Summary
 String getFullDisplayName()
           
 String getFullName()
          Gets the full name of this ItemGroup.
 T getItem(String name)
          Gets the Item inside this group that has a given name.
 Collection<T> getItems()
          Gets all the items in this collection in a read-only view.
 File getRootDirFor(T child)
          Assigns the root directory for children.
 String getUrl()
          Returns the path relative to the context root, like "foo/bar/zot/".
 String getUrlChildPrefix()
          Gets the URL token that prefixes the URLs for child Items.
 void onDeleted(T item)
          Internal method.
 void onRenamed(T item, String oldName, String newName)
          Internal method.
 
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

getFullName

String getFullName()
Gets the full name of this ItemGroup.

See Also:
Item.getFullName()

getFullDisplayName

String getFullDisplayName()
See Also:
Item.getFullDisplayName()

getItems

Collection<T> getItems()
Gets all the items in this collection in a read-only view.


getUrl

String getUrl()
Returns the path relative to the context root, like "foo/bar/zot/". Note no leading slash but trailing slash.


getUrlChildPrefix

String getUrlChildPrefix()
Gets the URL token that prefixes the URLs for child Items. Like "job", "item", etc.


getItem

T getItem(String name)
Gets the Item inside this group that has a given name.


getRootDirFor

File getRootDirFor(T child)
Assigns the root directory for children.


onRenamed

void onRenamed(T item,
               String oldName,
               String newName)
               throws IOException
Internal method. Called by Items when they are renamed by users.

Throws:
IOException

onDeleted

void onDeleted(T item)
               throws IOException
Internal method. Called by Items when they are deleted by users.

Throws:
IOException


Copyright © 2004-2013. All Rights Reserved.