com.microsoft.tfs.core.clients.reporting
Class ReportNode

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.reporting.ReportNode
All Implemented Interfaces:
Hierarchical, Labelable
Direct Known Subclasses:
Report, ReportFolder

public abstract class ReportNode
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
implements Labelable, Hierarchical

A node (report, folder, etc.) in the report hierarchy.

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

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
protected ReportNode(java.lang.String projectName, ms.sql.reporting.reportingservices._CatalogItem item)
           
protected ReportNode(java.lang.String projectName, java.lang.String path)
          Creates a ReportNode with only a path, no other fields initialized (they will be their default values).
 
Method Summary
 void addChild(ReportNode child)
           
 java.lang.Object[] getChildren()
           
 ReportNode[] getChildReportNodes()
           
 java.lang.String getCreatedBy()
           
 java.util.Calendar getCreationDate()
           
 java.lang.String getDescription()
           
 java.lang.String getID()
           
 java.lang.String getLabel()
           
 java.lang.String getModifiedBy()
           
 java.util.Calendar getModifiedDate()
           
 java.lang.Object getParent()
           
 java.lang.String getPath()
           
 java.lang.String getProjectName()
           
 java.lang.String getType()
           
 ms.sql.reporting.reportingservices._CatalogItem getWebServiceObject()
          Gets the web service object this class wraps.
 boolean hasChildren()
          This method is included because it's often less expensive to check for the existence of children than to retrieve the children.
 boolean isHidden()
           
 void setParent(java.lang.Object parent)
           
 java.lang.String toString()
          To string method overloaded to return the path of the report.
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportNode

protected ReportNode(java.lang.String projectName,
                     java.lang.String path)
Creates a ReportNode with only a path, no other fields initialized (they will be their default values). This constructor is provided for use by ReportFolder.

Parameters:
path - the path (must not be null)

ReportNode

protected ReportNode(java.lang.String projectName,
                     ms.sql.reporting.reportingservices._CatalogItem item)
Method Detail

getWebServiceObject

public ms.sql.reporting.reportingservices._CatalogItem getWebServiceObject()
Gets the web service object this class wraps. The returned object should not be modified.

Returns:
the web service object this class wraps.

getCreatedBy

public java.lang.String getCreatedBy()
Returns:
Returns the createdBy.

getCreationDate

public java.util.Calendar getCreationDate()
Returns:
Returns the creationDate.

getDescription

public java.lang.String getDescription()
Returns:
Returns the description.

getID

public java.lang.String getID()
Returns:
Returns the ID.

isHidden

public boolean isHidden()
Returns:
Returns the hidden.

getLabel

public java.lang.String getLabel()
Specified by:
getLabel in interface Labelable
Returns:
Returns the label.

getModifiedBy

public java.lang.String getModifiedBy()
Returns:
Returns the modifiedBy.

getModifiedDate

public java.util.Calendar getModifiedDate()
Returns:
Returns the modifiedDate.

getPath

public java.lang.String getPath()
Returns:
Returns the path.

getType

public java.lang.String getType()
Returns:
Returns the type.

toString

public java.lang.String toString()
To string method overloaded to return the path of the report.

Overrides:
toString in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

getParent

public java.lang.Object getParent()
Specified by:
getParent in interface Hierarchical
Returns:
Returns the parent.

setParent

public void setParent(java.lang.Object parent)
Parameters:
parent - The parent to set.

addChild

public void addChild(ReportNode child)

getChildReportNodes

public ReportNode[] getChildReportNodes()

getChildren

public java.lang.Object[] getChildren()
Specified by:
getChildren in interface Hierarchical
Returns:
the children of this object, or null if this object has no children

hasChildren

public boolean hasChildren()
Description copied from interface: Hierarchical
This method is included because it's often less expensive to check for the existence of children than to retrieve the children.

Specified by:
hasChildren in interface Hierarchical
Returns:
true if this object has children, false if not

getProjectName

public java.lang.String getProjectName()


© 2015 Microsoft. All rights reserved.