com.microsoft.tfs.core.clients.team
Class TeamService

java.lang.Object
  extended by com.microsoft.tfs.core.clients.team.TeamService

public class TeamService
extends java.lang.Object

A client for the TFS 2012 "Team" services.

Since:
TEE-SDK-11.0
Thread-safety:
thread-compatible

Constructor Summary
TeamService(TFSConnection connection)
           
 
Method Summary
 TeamFoundationTeam createTeam(java.lang.String projectId, java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,java.lang.Object> properties)
          Create a Team on server with optional properties
 TeamFoundationTeam getDefaultTeam(java.lang.String projectUri, java.lang.String[] propertyNameFilters)
           Gets default team for the project
 com.microsoft.tfs.util.GUID getDefaultTeamID(java.lang.String projectUri)
           Returns default team id for the project.
 TeamFoundationTeam[] queryTeams(IdentityDescriptor descriptor)
          Query all Team groups that given user is a member of.
 TeamFoundationTeam[] queryTeams(IdentityDescriptor descriptor, java.lang.String[] propertyNameFilters)
          Query all Team groups that given user is a member of.
 TeamFoundationTeam[] queryTeams(java.lang.String projectId)
           Query all Team groups in given project.
 TeamFoundationTeam readTeam(com.microsoft.tfs.util.GUID teamId, java.lang.String[] propertyNameFilters)
           Read Team group by descriptor
 TeamFoundationTeam readTeam(IdentityDescriptor descriptor, java.lang.String[] propertyNameFilters)
           Read Team group by descriptor
 TeamFoundationTeam readTeam(java.lang.String projectId, java.lang.String teamName, java.lang.String[] propertyNameFilters)
           Read Team group by name in given project
 void setDefaultTeam(TeamFoundationTeam team)
           Sets default team for the project
 void setDefaultTeamID(java.lang.String projectUri, com.microsoft.tfs.util.GUID teamId)
           Sets default team for the project
 void updateTeam(TeamFoundationTeam team)
           Persist Team updates.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TeamService

public TeamService(TFSConnection connection)
Method Detail

createTeam

public TeamFoundationTeam createTeam(java.lang.String projectId,
                                     java.lang.String name,
                                     java.lang.String description,
                                     java.util.Map<java.lang.String,java.lang.Object> properties)
Create a Team on server with optional properties

Parameters:
projectId - Project Uri (scope id)
name - Team name
description - Team description
properties - properties, can be null or empty
Returns:
TeamFoundationTeam

queryTeams

public TeamFoundationTeam[] queryTeams(java.lang.String projectId)

Query all Team groups in given project.

Parameters:
projectId - Project Uri (scope id)

queryTeams

public TeamFoundationTeam[] queryTeams(IdentityDescriptor descriptor)
Query all Team groups that given user is a member of.


queryTeams

public TeamFoundationTeam[] queryTeams(IdentityDescriptor descriptor,
                                       java.lang.String[] propertyNameFilters)
Query all Team groups that given user is a member of.


readTeam

public TeamFoundationTeam readTeam(IdentityDescriptor descriptor,
                                   java.lang.String[] propertyNameFilters)

Read Team group by descriptor

Parameters:
propertyNameFilters - specifies extended properties to read, refer Prpoperty Service API. Set to null to read all properties.
Returns:
Team object if group exists AND is a team, else null

readTeam

public TeamFoundationTeam readTeam(com.microsoft.tfs.util.GUID teamId,
                                   java.lang.String[] propertyNameFilters)

Read Team group by descriptor

Parameters:
propertyNameFilters - specifies extended properties to read, refer Prpoperty Service API. Set to null to read all properties.
propertyNameFilters - specifies extended properties to read, refer Prpoperty Service API. Set to null to read all properties.
Returns:
Team object if group exists AND is a team, else null

Read Team group by id


readTeam

public TeamFoundationTeam readTeam(java.lang.String projectId,
                                   java.lang.String teamName,
                                   java.lang.String[] propertyNameFilters)

Read Team group by name in given project

Parameters:
projectId - Project Uri (scope id)
propertyNameFilters - specifies extended properties to read, refer Prpoperty Service API. Set to null to read all properties.
Returns:
Team object if group exists AND is a team, else null

getDefaultTeamID

public com.microsoft.tfs.util.GUID getDefaultTeamID(java.lang.String projectUri)

Returns default team id for the project.

Parameters:
projectUri -
Returns:

getDefaultTeam

public TeamFoundationTeam getDefaultTeam(java.lang.String projectUri,
                                         java.lang.String[] propertyNameFilters)

Gets default team for the project

Parameters:
projectUri -
propertyNameFilters -
Returns:

setDefaultTeam

public void setDefaultTeam(TeamFoundationTeam team)

Sets default team for the project

Parameters:
team -

setDefaultTeamID

public void setDefaultTeamID(java.lang.String projectUri,
                             com.microsoft.tfs.util.GUID teamId)

Sets default team for the project

Parameters:
projectUri -
teamId -

updateTeam

public void updateTeam(TeamFoundationTeam team)

Persist Team updates.



© 2015 Microsoft. All rights reserved.