|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryFolder
Represents a folder in Team Foundation Server that can be queried.
Method Summary | |
---|---|
void |
add(QueryItem item)
Adds the given QueryItem as a child of this folder. |
boolean |
contains(QueryItem item)
Determines whether this folder contains the given QueryItem . |
boolean |
containsID(com.microsoft.tfs.util.GUID id)
Determines whether this folder contains a child QueryItem with
the given id. |
boolean |
containsName(java.lang.String name)
Determines whether this folder contains a child QueryItem with
the given name (ignoring case.) Note that this is not recursive. |
QueryItem |
getItemByID(com.microsoft.tfs.util.GUID id)
Returns the child QueryItem with the given id. |
QueryItem |
getItemByName(java.lang.String name)
Returns the child QueryItem with the given name. |
QueryItem[] |
getItems()
Gets the child QueryItem s contained by this folder. |
QueryDefinition |
newDefinition(java.lang.String definitionName,
java.lang.String queryText)
Creates a new QueryDefinition beneath this folder. |
QueryFolder |
newFolder(java.lang.String folderName)
Creates a new QueryFolder beneath this folder. |
Methods inherited from interface com.microsoft.tfs.core.clients.workitem.queryhierarchy.QueryItem |
---|
delete, getID, getName, getOriginalName, getOriginalOwnerDescriptor, getOriginalParent, getOwnerDescriptor, getParent, getProject, getType, isDeleted, isDirty, isNew, isPersonal, setName, setOwnerDescriptor |
Method Detail |
---|
QueryItem[] getItems()
QueryItem
s contained by this folder.
QueryItem
s (never null
)boolean contains(QueryItem item)
QueryItem
. Note
that this is not recursive.
item
- The potential child QueryItem
(not null
).
true
if this folder contains the given
QueryItem
, false
otherwise.boolean containsID(com.microsoft.tfs.util.GUID id)
QueryItem
with
the given id. Note that this is not recursive.
id
- The id of the potential child QueryItem
(not
null
).
true
if this folder contains a QueryItem
with the given id, false
otherwise.boolean containsName(java.lang.String name)
QueryItem
with
the given name (ignoring case.) Note that this is not recursive.
name
- The name of the potential child QueryItem
(not
null
).
true
if this folder contains a QueryItem
with the given name, false
otherwise.QueryItem getItemByID(com.microsoft.tfs.util.GUID id)
QueryItem
with the given id.
id
- The id of the child QueryItem
(not null
).
QueryItem
with the given id.
java.lang.IllegalArgumentException
- if no child QueryItem
exists with the given id.QueryItem getItemByName(java.lang.String name)
QueryItem
with the given name.
name
- The name of the child QueryItem
(not null
).
QueryItem
with the given name.
java.lang.IllegalArgumentException
- if no child QueryItem
exists with the given name.void add(QueryItem item)
QueryItem
as a child of this folder.
item
- The child QueryItem
to add to this folder (not
null
).
java.lang.IllegalArgumentException
- if the given QueryItem
cannot be added to this folder
because this folder is the root of the query hierarchy, the
folder is being deleted from the server, the given
QueryItem
is a folder and the server is a pre-TFS 2010
version that does not support query hierarchies, the given
QueryItem
is associated with a different Team Project
than this folder, or the given QueryItem
already exists
in the query hierarchy as a parent of this folder.
WorkItemException
- if a child with the same name already existsQueryFolder newFolder(java.lang.String folderName)
QueryFolder
beneath this folder.
folderName
- The name of the folder to create (not null
)
QueryFolder
.QueryDefinition newDefinition(java.lang.String definitionName, java.lang.String queryText)
QueryDefinition
beneath this folder.
definitionName
- The name of the query to create (not null
)queryText
- The WIQL to create the query with (not null
or empty)
QueryDefinition
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |