com.microsoft.tfs.core.clients.workitem.queryhierarchy
Interface QueryDefinition

All Superinterfaces:
QueryItem

public interface QueryDefinition
extends QueryItem

Represents a stored query definition in the query hierarchy.

Since:
TEE-SDK-10.1
Thread-safety:
unknown

Method Summary
 java.lang.String getOriginalQueryText()
          Returns the original WIQL query text for this query definition as it was loaded from the server, before any unsaved modifications.
 java.lang.String getQueryText()
          Returns the WIQL query text for this query definition.
 QueryType getQueryType()
          Returns the hierarchical return type of this query.
 void setQueryText(java.lang.String queryText)
          Sets the WIQL query text for this query definition.
 
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

getQueryText

java.lang.String getQueryText()
Returns the WIQL query text for this query definition.

Returns:
The WIQL query text for this query definition, or null.

getOriginalQueryText

java.lang.String getOriginalQueryText()
Returns the original WIQL query text for this query definition as it was loaded from the server, before any unsaved modifications.

Returns:
The original WIQL query text for this query definition, or null.

setQueryText

void setQueryText(java.lang.String queryText)
                  throws InvalidQueryTextException
Sets the WIQL query text for this query definition.

Parameters:
queryText - The WIQL query text for this query definition (not null or empty).
Throws:
WorkItemException - If this query definition has been deleted.
InvalidQueryTextException - If the specified WIQL is not valid.

getQueryType

QueryType getQueryType()
Returns the hierarchical return type of this query.

Returns:
The QueryType of this query.


© 2015 Microsoft. All rights reserved.