KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > hudson > model > ItemGroup


1 package hudson.model;
2
3 import java.util.Collection JavaDoc;
4 import java.io.File JavaDoc;
5
6 /**
7  * Represents a grouping inherent to a kind of {@link Item}s.
8  *
9  * @author Kohsuke Kawaguchi
10  */

11 public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject {
12     /**
13      * Gets the full name of this {@link ItemGroup}.
14      *
15      * @see Item#getFullName()
16      */

17     String JavaDoc getFullName();
18
19     /**
20      * Gets all the items in this collection in a read-only view.
21      */

22     Collection JavaDoc<T> getItems();
23
24     /**
25      * Returns the path relative to the context root,
26      * like "foo/bar/zot/". Note no leading slash but trailing slash.
27      */

28     String JavaDoc getUrl();
29
30     /**
31      * Gets the URL token that prefixes the URLs for child {@link Item}s.
32      * Like "job", "item", etc.
33      */

34     String JavaDoc getUrlChildPrefix();
35
36     /**
37      * Gets the {@link Item} inside this group that has a given name.
38      */

39     T getItem(String JavaDoc name);
40
41     /**
42      * Assigns the {@link Item#getRootDir() root directory} for children.
43      */

44     File JavaDoc getRootDirFor(T child);
45 }
46
Popular Tags