|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StoredQuery
Represents a stored query.
Method Summary | |
---|---|
Query |
createQuery(java.util.Map<java.lang.String,java.lang.Object> queryContext)
Creates a new Query from this StoredQuery . |
java.util.Date |
getCreationTime()
|
java.lang.String |
getDescription()
|
java.util.Date |
getLastWriteTime()
|
java.lang.String |
getName()
|
java.lang.String |
getOwner()
|
Project |
getProject()
|
com.microsoft.tfs.util.GUID |
getQueryGUID()
|
QueryScope |
getQueryScope()
|
java.lang.String |
getQueryText()
|
boolean |
isParsable()
|
boolean |
isSaved()
|
void |
reset()
Resets all changes that were made to this query to the initial state. |
WorkItemCollection |
runQuery(java.util.Map<java.lang.String,java.lang.Object> queryContext)
Runs this stored query directly. |
void |
setDescription(java.lang.String description)
Sets the description of this stored query. |
void |
setName(java.lang.String name)
Sets the name of this stored query. |
void |
setQueryScope(QueryScope scope)
Sets the scope of this stored query. |
void |
setQueryText(java.lang.String text)
Sets the query string. |
void |
update()
Updates the stored query. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Method Detail |
---|
void reset()
void update()
java.util.Date getCreationTime()
java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- the new description (may be null
or empty)boolean isSaved()
true
if this stored query has been saved,
false
otherwisejava.util.Date getLastWriteTime()
java.lang.String getName()
void setName(java.lang.String name)
name
- the new name (must not be null
)java.lang.String getOwner()
Project getProject()
com.microsoft.tfs.util.GUID getQueryGUID()
GUID
that is associated with this stored query.QueryScope getQueryScope()
void setQueryScope(QueryScope scope)
scope
- the QueryScope
(must not be null
)java.lang.String getQueryText()
void setQueryText(java.lang.String text) throws InvalidQueryTextException
text
- the query string (must not be null
or empty)
InvalidQueryTextException
- if the query text was not valid WIQLQuery createQuery(java.util.Map<java.lang.String,java.lang.Object> queryContext) throws InvalidQueryTextException
Query
from this StoredQuery
.
Query
InvalidQueryTextException
- if this StoredQuery
's query text is not valid WIQLWorkItemCollection runQuery(java.util.Map<java.lang.String,java.lang.Object> queryContext) throws InvalidQueryTextException
#createQuery()
.
#runQuery()
.
InvalidQueryTextException
- if this StoredQuery
's query text is not valid WIQLboolean isParsable()
true
if the current query text is valid WIQL,
false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |