com.microsoft.tfs.core.clients.workitem.project
Interface Project

All Superinterfaces:
java.lang.Comparable<Project>

public interface Project
extends java.lang.Comparable<Project>

Represents a work item tracking project.

Since:
TEE-SDK-10.1

Method Summary
 boolean addProjectModificationListener(ProjectModificationListener listener)
          Adds a listener for the project modification event.
 void clearCachedWITMetadata()
          Removes the locally cached work item metadata, which will be repopulated on demand.
 StoredQueryCollection getAndRefreshStoredQueries()
          Deprecated. please use getQueryHierarchy instead
 NodeCollection getAreaRootNodes()
           
 CategoryCollection getCategories()
           
 CategoryMemberCollection getCategoryMembers()
           
 com.microsoft.tfs.util.GUID getGUID()
           
 int getID()
           
 NodeCollection getIterationRootNodes()
           
 java.lang.String getName()
           
 QueryHierarchy getQueryHierarchy()
           
 StoredQueryCollection getStoredQueries()
          Deprecated. please use getQueryHierarchy instead
 java.lang.String getURI()
           
 WorkItemType[] getVisibleWorkItemTypes()
           
 com.microsoft.tfs.core.clients.workitem.internal.WITContext getWITContext()
           
 WorkItemClient getWorkItemClient()
           
 WorkItemTypeCollection getWorkItemTypes()
           
 void notifyModicationListeners()
          Notifies all project modification listeners.
 boolean removeProjectModificationListener(ProjectModificationListener listener)
          Removes a listener for the project modification event.
 java.lang.Object resolvePath(java.lang.String path, Node.TreeType treeType)
          Gets the Project or Node or other object which corresponds to the specified Area or Iteration path and type.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

java.lang.String getName()
Returns:
the name of this project.

getID

int getID()
Returns:
the ID of this project.

getGUID

com.microsoft.tfs.util.GUID getGUID()
Returns:
the GUID of the Node which belongs to this project.

getURI

java.lang.String getURI()
Returns:
the URI of this project.

getWorkItemTypes

WorkItemTypeCollection getWorkItemTypes()
Returns:
a collection of WorkItemType objects that belong to this project.

getVisibleWorkItemTypes

WorkItemType[] getVisibleWorkItemTypes()
Returns:
an array of WorkItemType objects that belong to this project and are not in the "Hidden" category.

getStoredQueries

@Deprecated
StoredQueryCollection getStoredQueries()
Deprecated. please use getQueryHierarchy instead


getAndRefreshStoredQueries

@Deprecated
StoredQueryCollection getAndRefreshStoredQueries()
Deprecated. please use getQueryHierarchy instead


getAreaRootNodes

NodeCollection getAreaRootNodes()
Returns:
the collection of area root nodes.

getIterationRootNodes

NodeCollection getIterationRootNodes()
Returns:
the collection of iteration root nodes.

getQueryHierarchy

QueryHierarchy getQueryHierarchy()
Returns:
the collection of query items that is associated with this project.

getCategories

CategoryCollection getCategories()
Returns:
the collection of work item type categories that belong to this project.

getCategoryMembers

CategoryMemberCollection getCategoryMembers()
Returns:
the collection of work item type category membership that belong to this project.

resolvePath

java.lang.Object resolvePath(java.lang.String path,
                             Node.TreeType treeType)
Gets the Project or Node or other object which corresponds to the specified Area or Iteration path and type.

Parameters:
path - the path to resolve (must not be null)
treeType - the Node.TreeType of the item to resolve as (must not be null)
Returns:
the object found at the specified path, or null if none was found

addProjectModificationListener

boolean addProjectModificationListener(ProjectModificationListener listener)
Adds a listener for the project modification event.

Parameters:
listener - the listener to add
Returns:
true always

removeProjectModificationListener

boolean removeProjectModificationListener(ProjectModificationListener listener)
Removes a listener for the project modification event.

Parameters:
listener - the listener to remove
Returns:
true if the Project contained the listener and it was removed, false if the Project did not contain the listener

notifyModicationListeners

void notifyModicationListeners()
Notifies all project modification listeners.


getWorkItemClient

WorkItemClient getWorkItemClient()
Returns:
the WorkItemClient for this Project

getWITContext

com.microsoft.tfs.core.clients.workitem.internal.WITContext getWITContext()
Returns:
the WITContext for this Project

clearCachedWITMetadata

void clearCachedWITMetadata()
Removes the locally cached work item metadata, which will be repopulated on demand.



© 2015 Microsoft. All rights reserved.