com.crystaldecisions.sdk.occa.report.definition
Interface IReportPartID

All Superinterfaces:
IClone
All Known Implementing Classes:
ReportPartID

public interface IReportPartID
extends IClone

This interface is used to identify a report part within the report. Report parts include chart, text, and field objects. You need to specify the name and the data context of the object.


Method Summary
 java.lang.String getDataContext()
          Returns a data subtree in the report.
 java.lang.String getName()
          Returns the name of the report part.
 void setDataContext(java.lang.String context)
          Sets a data subtree in the report.
 void setName(java.lang.String name)
          Sets the name of the report part.
 

Method Detail

getName

java.lang.String getName()

Returns the name of the report part.

Returns:
The name of the report part as a String.

setName

void setName(java.lang.String name)

Sets the name of the report part.

Parameters:
name - The name of the report part as a String.

getDataContext

java.lang.String getDataContext()

Returns a data subtree in the report. The data context represents the whole group tree or a sub tree in the group tree. DataContext can be specified using either strings or integers to narrow down the search for the report object. For example, "/Country[USA]/Region[CA]" or "2-1". You can use a wildcard (*) in the last position only. For example, "/Country[USA]/ Region[CA]/*" or "2-1-*".

Returns:
The data subtree name of the report part as a String.

setDataContext

void setDataContext(java.lang.String context)

Sets a data subtree in the report. The data context represents the whole group tree or a sub tree in the group tree. DataContext can be specified using either strings or integers to narrow down the search for the report object. For example, "/Country[USA]/Region[CA]" or "2-1". You can use a wildcard (*) in the last position only. For example, "/Country[USA]/ Region[CA]/*" or "2-1-*".

Parameters:
context - The data subtree name of the report part as a String.