|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.clients.workitem.WorkItemClient
public final class WorkItemClient
Provides access to the Work Item Tracking services.
Constructor Summary | |
---|---|
WorkItemClient(TFSTeamProjectCollection connection,
ms.tfs.workitemtracking.clientservices._03._ClientService2Soap webService2,
ms.tfs.workitemtracking.clientservices._03._ClientService3Soap webService3,
ms.tfs.workitemtracking.clientservices._03._ClientService5Soap webService5)
|
Method Summary | |
---|---|
void |
close()
Closes this work item client down. |
Query |
createEmptyQuery()
|
Query |
createQuery(java.lang.String wiql)
|
Query |
createQuery(java.lang.String wiql,
BatchReadParameterCollection batchReadParams)
|
Query |
createQuery(java.lang.String wiql,
java.util.Map<java.lang.String,java.lang.Object> queryContext)
|
Query |
createReferencingQuery(java.lang.String artifactUri)
|
void |
deleteWorkItemByID(int id)
|
void |
deleteWorkItemType(java.lang.String projectName,
java.lang.String workItemTypeName)
|
TFSTeamProjectCollection |
getConnection()
|
java.util.Properties |
getDatabaseConfigurationDebugInfo(java.util.Locale locale)
Gets localized database configuration properties for use in support situations. |
java.io.File |
getDatabaseDirectory()
|
java.io.File |
getDatabaseDiskDirectoryForDebugInfo()
|
static QueryFolder |
getDefaultParent(Project project,
boolean isPublic)
|
WorkItemEventEngine |
getEventEngine()
|
FieldDefinitionCollection |
getFieldDefinitions()
|
java.lang.String[] |
getGlobalAndProjectGroups(com.microsoft.tfs.util.GUID serverGuid,
com.microsoft.tfs.util.GUID projectGuid)
Get list of TFS Global and Project groups |
GroupDataProvider |
getGroupDataProvider(java.lang.String projectName)
Retrieve the cached group data provider for the specified project name. |
WorkItemLinkTypeCollection |
getLinkTypes()
|
IProcessGuidance |
getProcessGuidance()
|
ProjectCollection |
getProjects()
Obtain the Project objects managed by this client. |
RegisteredLinkTypeCollection |
getRegisteredLinkTypes()
|
StoredQuery |
getStoredQuery(com.microsoft.tfs.util.GUID guid)
Similar to "WorkItemStore#GetStoredQuery(Guid)" in MS code. |
java.lang.String |
getUpdateXMLForDebugging(WorkItem workItem)
|
UserDisplayMode |
getUserDisplayMode()
|
java.lang.String |
getUserDisplayName()
|
WorkItemServerVersion |
getVersion()
|
ms.tfs.workitemtracking.clientservices._03._ClientService2Soap |
getWebService2()
|
ms.tfs.workitemtracking.clientservices._03._ClientService3Soap |
getWebService3()
|
ms.tfs.workitemtracking.clientservices._03._ClientService5Soap |
getWebService5()
|
WorkItem |
getWorkItemByID(int id)
Retrieves a work item by ID from the TFS server. |
WorkItem |
newWorkItem(WorkItemType inputType)
|
void |
precacheData()
Pre-caches data that is used by this client. |
WorkItemCollection |
query(int[] ids,
java.lang.String wiql)
|
WorkItemCollection |
query(java.lang.String wiql)
|
WorkItemCollection |
query(java.lang.String wiql,
BatchReadParameterCollection batchReadParams)
|
WorkItemCollection |
query(java.lang.String wiql,
java.util.Map<java.lang.String,java.lang.Object> queryContext)
|
WorkItemCollection |
query(java.lang.String wiql,
java.util.Map<java.lang.String,java.lang.Object> queryContext,
boolean dayPrecision)
|
void |
refreshCache()
|
boolean |
supportsLinkQueries()
|
boolean |
supportsReadOnlyLinkTypes()
|
boolean |
supportsWebAccessWorkItems()
|
boolean |
supportsWIQLEvaluationOnServer()
|
boolean |
supportsWIQLFieldAndGroupOperators()
|
boolean |
supportsWorkItemLinkTypes()
|
void |
validateWIQL(java.lang.String wiql)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkItemClient(TFSTeamProjectCollection connection, ms.tfs.workitemtracking.clientservices._03._ClientService2Soap webService2, ms.tfs.workitemtracking.clientservices._03._ClientService3Soap webService3, ms.tfs.workitemtracking.clientservices._03._ClientService5Soap webService5)
Method Detail |
---|
public boolean supportsWorkItemLinkTypes()
public boolean supportsReadOnlyLinkTypes()
public boolean supportsLinkQueries()
public boolean supportsWIQLFieldAndGroupOperators()
public boolean supportsWebAccessWorkItems()
public boolean supportsWIQLEvaluationOnServer()
public java.io.File getDatabaseDirectory()
public java.util.Properties getDatabaseConfigurationDebugInfo(java.util.Locale locale)
locale
- the Locale
to localize info strings to (null
to use the default locale)
null
)public java.io.File getDatabaseDiskDirectoryForDebugInfo()
public WorkItem getWorkItemByID(int id)
id
- ID of the work item to retrieve
public void deleteWorkItemByID(int id)
public void deleteWorkItemType(java.lang.String projectName, java.lang.String workItemTypeName)
public WorkItemServerVersion getVersion()
public ms.tfs.workitemtracking.clientservices._03._ClientService2Soap getWebService2()
public ms.tfs.workitemtracking.clientservices._03._ClientService3Soap getWebService3()
null
)public ms.tfs.workitemtracking.clientservices._03._ClientService5Soap getWebService5()
null
)public void precacheData()
public void refreshCache()
public ProjectCollection getProjects()
public GroupDataProvider getGroupDataProvider(java.lang.String projectName)
projectName
- The project to get groups for.
public java.lang.String[] getGlobalAndProjectGroups(com.microsoft.tfs.util.GUID serverGuid, com.microsoft.tfs.util.GUID projectGuid)
serverGuid
- Guid for the server for which group information needs to be
retrievedprojectGuid
- Guid for the project for which group information needs to be
retrieved
public void close()
close
in interface com.microsoft.tfs.util.Closable
public WorkItem newWorkItem(WorkItemType inputType)
public FieldDefinitionCollection getFieldDefinitions()
public RegisteredLinkTypeCollection getRegisteredLinkTypes()
public WorkItemLinkTypeCollection getLinkTypes()
public java.lang.String getUpdateXMLForDebugging(WorkItem workItem)
public TFSTeamProjectCollection getConnection()
public StoredQuery getStoredQuery(com.microsoft.tfs.util.GUID guid)
public Query createReferencingQuery(java.lang.String artifactUri)
public Query createQuery(java.lang.String wiql, java.util.Map<java.lang.String,java.lang.Object> queryContext) throws InvalidQueryTextException
InvalidQueryTextException
public Query createQuery(java.lang.String wiql) throws InvalidQueryTextException
InvalidQueryTextException
public Query createQuery(java.lang.String wiql, BatchReadParameterCollection batchReadParams) throws InvalidQueryTextException
InvalidQueryTextException
public Query createEmptyQuery()
public WorkItemCollection query(java.lang.String wiql, java.util.Map<java.lang.String,java.lang.Object> queryContext, boolean dayPrecision) throws InvalidQueryTextException
InvalidQueryTextException
public WorkItemCollection query(java.lang.String wiql, java.util.Map<java.lang.String,java.lang.Object> queryContext) throws InvalidQueryTextException
InvalidQueryTextException
public WorkItemCollection query(int[] ids, java.lang.String wiql) throws InvalidQueryTextException
InvalidQueryTextException
public WorkItemCollection query(java.lang.String wiql) throws InvalidQueryTextException
InvalidQueryTextException
public WorkItemCollection query(java.lang.String wiql, BatchReadParameterCollection batchReadParams) throws InvalidQueryTextException
InvalidQueryTextException
public void validateWIQL(java.lang.String wiql) throws InvalidQueryTextException
InvalidQueryTextException
public IProcessGuidance getProcessGuidance()
public static QueryFolder getDefaultParent(Project project, boolean isPublic)
public UserDisplayMode getUserDisplayMode()
public java.lang.String getUserDisplayName()
public WorkItemEventEngine getEventEngine()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |