com.microsoft.tfs.core.clients.framework.catalog
Class CatalogResource

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.framework.catalog.CatalogResource

public class CatalogResource
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

Wrapper class for the _CatalogResource proxy object which is contained within the result of a TFS catalog web service.

Since:
TEE-SDK-10.1
Thread-safety:
thread-safe

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
CatalogResource(ms.ws._CatalogResource catalogResource)
          Wrapper constructor.
 
Method Summary
 java.lang.String getDescription()
          Returns the description for this resource.
 java.lang.String getDisplayName()
          Returns the display name for this resource.
 java.lang.String getIdentifier()
          Returns the identifier for this resource.
 CatalogNode[] getNodeReferences()
          Returns the node references for this resource.
 java.util.HashMap<java.lang.String,java.lang.String> getProperties()
          Returns the properties associated with this resource.
 CatalogResourceType getResourceType()
          Return the type for this resource.
 java.lang.String getResourceTypeIdentifier()
          Returns the resource type identifier for this resource.
 java.util.HashMap<java.lang.String,ServiceDefinition> getServiceReferences()
          Returns the serviceReferences associated with this resource.
 ms.ws._CatalogResource getWebServiceObject()
          Returns the wrapped proxy object.
 void initializeFromWebService(java.util.HashMap<java.lang.String,CatalogResourceType> typeMap, java.util.HashMap<java.lang.String,CatalogNode> nodeMap, ILocationService locationService)
          Used internally during post-processing of a catalog web service request result.
 boolean isMatchedQuery()
          Returns true if this resource matched the query criteria.
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CatalogResource

public CatalogResource(ms.ws._CatalogResource catalogResource)
Wrapper constructor.

Method Detail

getWebServiceObject

public ms.ws._CatalogResource getWebServiceObject()
Returns the wrapped proxy object.


getIdentifier

public java.lang.String getIdentifier()
Returns the identifier for this resource.


getResourceTypeIdentifier

public java.lang.String getResourceTypeIdentifier()
Returns the resource type identifier for this resource.


getDisplayName

public java.lang.String getDisplayName()
Returns the display name for this resource.


getDescription

public java.lang.String getDescription()
Returns the description for this resource.


isMatchedQuery

public boolean isMatchedQuery()
Returns true if this resource matched the query criteria.


getResourceType

public CatalogResourceType getResourceType()
Return the type for this resource.


getServiceReferences

public java.util.HashMap<java.lang.String,ServiceDefinition> getServiceReferences()
Returns the serviceReferences associated with this resource. The map which is returned contains a key which is the _ServiceReference.AssociationKey and a value which is a ServiceDefinition.


getProperties

public java.util.HashMap<java.lang.String,java.lang.String> getProperties()
Returns the properties associated with this resource. The map which is returned contains name/value pairs which are String/String.


getNodeReferences

public CatalogNode[] getNodeReferences()
Returns the node references for this resource.


initializeFromWebService

public void initializeFromWebService(java.util.HashMap<java.lang.String,CatalogResourceType> typeMap,
                                     java.util.HashMap<java.lang.String,CatalogNode> nodeMap,
                                     ILocationService locationService)
Used internally during post-processing of a catalog web service request result. Initializes the members of this class which are not part of the underlying proxy object.

Parameters:
typeMap - A map of resource types keyed by resource type identifiers.
nodeMap - A map of catalog nodes keyed by node paths.
locationService - The catalog service that was used to retrieve these results.


© 2015 Microsoft. All rights reserved.