public interface VisualReportBuilder extends Builder
VisualReport
s.
VisualReportManager.createVisualReportBuilder(nxopen.visualreporting.VisualReport)
Type | Property and Description |
---|---|
String |
bitmapNameOfReporting
Returns the bitmap name of the reporting
Property in the active Classifier . |
String |
customMessageOfReporting
Returns the custom message of the reporting
Property in the active Classifier . |
Modifier and Type | Interface and Description |
---|---|
static class |
VisualReportBuilder.PropertySpecificationData
This class holds the data returned from
getPropertySpecification(nxopen.visualreporting.Property) |
static class |
VisualReportBuilder.PropertyUsageOption
Represents the usage option of reference
Property |
static class |
VisualReportBuilder.ReferencePropertiesOfReportData
This class holds the data returned from
getReferencePropertiesOfReport() |
static class |
VisualReportBuilder.ReferencePropertiesOfReportingPropertyData
This class holds the data returned from
getReferencePropertiesOfReportingProperty() |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
String bitmapNameOfReportingProperty
Property
in the active Classifier
.
NXException
RemoteException
String customMessageOfReportingProperty
Property
in the active Classifier
.
NXException
RemoteException
VisualReport createVisualReport() throws NXException, RemoteException
VisualReport
and starts editing it.
The created VisualReport
will not be added to the
VisualReportManager
until Builder.commit()
or commitAsCopy()
is called on this builder.
NXException
RemoteException
void editVisualReport(VisualReport visualReport) throws NXException, RemoteException
VisualReport
. The builder will create a
copy of the given VisualReport and all edits will be applied to that copy. When
Builder.commit()
is called on this builder, the supplied
VisualReport will be deleted and replaced with the new one. Alternatively if
commitAsCopy()
is called, the copied VisualReport
will be added to the VisualReportManager
without deleting the one given in this function.
Any current VisualReport
which this builder is currently
building will be deleted when this function is called.
visualReport
- The visual reportNXException
RemoteException
VisualReport commitAsCopy() throws NXException, RemoteException
Builder.commit()
is called on this builder, it will
delete the original VisualReport
whose copy the builder is editing and install the copied
VisualReport
to the VisualReportManager
.
If it is required not to delete the original VisualReport
,
then commitAsCopy()
can be called instead. This behaves
just like Builder.commit()
except it does not delete the
original VisualReport
.
NXException
RemoteException
String filenameOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this
builder.
Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database.
If it is a new report, it will be the report dataset name. When the report is save by save()
,
the report dataset identifier will be saved in this property.
NXException
RemoteException
void setFilenameOfVisualReport(String filename) throws NXException, RemoteException
filename
- The file nameNXException
RemoteException
String reportNameOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this builder.
NXException
RemoteException
void setReportNameOfVisualReport(String reportName) throws NXException, RemoteException
reportName
- The name of the reportNXException
RemoteException
String descriptionOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this
builder.
NXException
RemoteException
void setDescriptionOfVisualReport(String description) throws NXException, RemoteException
description
- The descriptionNXException
RemoteException
VisualReport.ReportingStyleOption reportingStyleOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this builder.
NXException
RemoteException
void setReportingStyleOfVisualReport(VisualReport.ReportingStyleOption reportingStyle) throws NXException, RemoteException
reportingStyle
- The reporting style being setNXException
RemoteException
VisualReport.ReportingObjectTypeOption reportingObjectTypeOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this builder.
Only valid if the VisualReport.scopeType()
of the VisualReport
is VisualReport.ScopeTypeOption.COMPONENT
type.
NXException
RemoteException
void setReportingObjectTypeOfVisualReport(VisualReport.ReportingObjectTypeOption reportingObjectType) throws NXException, RemoteException
reportingObjectType
- The reporting object being setNXException
RemoteException
void enableUnmatchedGroupOfVisualReport(boolean enableUnmatchedGroup) throws NXException, RemoteException
VisualReport.unmatchedGroupLabel()
is enabled for the VisualReport
being built by this builder.
enableUnmatchedGroup
- Whether the unmatched group is enabledNXException
RemoteException
Rule getRule(int index) throws NXException, RemoteException
Rule
from the VisualReport
being built by this builder.
index
- The index of the returned Rule
.NXException
RemoteException
Rule[] getRules() throws NXException, RemoteException
Rule
s in the VisualReport
being built by this builder.
NXException
RemoteException
Classifier[] getClassifiersOfRule(Rule rule) throws NXException, RemoteException
rule
- NXException
RemoteException
Classifier getActiveClassifierOfRule(Rule rule) throws NXException, RemoteException
Classifier
in this Rule
for a multiple properties report.
rule
- NXException
RemoteException
void setActiveClassifierOfRule(Rule rule, Classifier activeClassifier) throws NXException, RemoteException
Classifier
in this Rule
for a multiple properties report.
rule
- activeClassifier
- NXException
RemoteException
String bitmapNameOfReportingProperty() throws NXException, RemoteException
Property
in the active Classifier
.
NXException
RemoteException
void setBitmapNameOfReportingProperty(String bitmapName) throws NXException, RemoteException
bitmapName
- The bitmap nameNXException
RemoteException
String customMessageOfReportingProperty() throws NXException, RemoteException
Property
in the active Classifier
.
NXException
RemoteException
void setCustomMessageOfReportingProperty(String customMessage) throws NXException, RemoteException
customMessage
- The custom messageNXException
RemoteException
VisualReportBuilder.ReferencePropertiesOfReportingPropertyData getReferencePropertiesOfReportingProperty() throws NXException, RemoteException
Property
list of the Property
in the active Classifier
.
NXException
RemoteException
void setReferencePropertiesOfReportingProperty(Property[] properties, VisualReportBuilder.PropertyUsageOption[] usages) throws NXException, RemoteException
Property
list of the Property
in the active Classifier
.
properties
- The reference properties of propertyusages
- The usagesNXException
RemoteException
Property getPropertyOfCondition(Condition condition) throws NXException, RemoteException
Property
of this condition.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionNXException
RemoteException
void setPropertyOfCondition(Condition condition, Property property) throws NXException, RemoteException
Property
of this condition. If the
Property
is set to null, then it is
deleted.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionproperty
- The property being setNXException
RemoteException
void removePropertyFromCondition(Condition condition) throws NXException, RemoteException
Property
from this condition
without deleting it.
condition
- The conditionNXException
RemoteException
Condition.OperatorOption getOperatorTypeOfCondition(Condition condition) throws NXException, RemoteException
Condition.OperatorOption
of this condition. Only valid if
Condition.TypeOption
is
Condition.TypeOption.VALUE_CONDITION
condition
- The conditionNXException
RemoteException
void setOperatorTypeOfCondition(Condition condition, Condition.OperatorOption operatorType) throws NXException, RemoteException
Condition.OperatorOption
of this condition. Only valid if
Condition.TypeOption
is
Condition.TypeOption.VALUE_CONDITION
condition
- The conditionoperatorType
- The operator type being setNXException
RemoteException
String getValueOfCondition(Condition condition) throws NXException, RemoteException
Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- NXException
RemoteException
void setValueOfCondition(Condition condition, String value) throws NXException, RemoteException
Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- value
- NXException
RemoteException
Property getPropertyForComparison(Condition condition) throws NXException, RemoteException
Property
in the value for comparison of this Condition
.
condition
- The conditionNXException
RemoteException
void setPropertyForComparison(Condition condition, Property property) throws NXException, RemoteException
Property
in the value for comparison of this Condition
. If the
Property
is set to null, then it is
deleted.
condition
- The conditionproperty
- The property being setNXException
RemoteException
void addChildToCondition(Condition condition, Condition childCondition) throws NXException, RemoteException
Condition
to this condition. If the child is already a
child of another Condition
or Rule
, then it is
removed from that other object. The new child must have been created in the same
VisualReport
as this parent condition. If this is a
Condition.TypeOption.NOT_CONDITION
then
this replaces the existing child, and the existing child is deleted.
condition
- The conditionchildCondition
- The child condition being addedNXException
RemoteException
void removeChildFromCondition(Condition condition, Condition childCondition) throws NXException, RemoteException
Property
that will be deleted too. If the condition has any child conditions, those will all
be deleted too.
condition
- The conditionchildCondition
- The child condition being removedNXException
RemoteException
boolean getHasUserSpecifiedValueForCondition(Condition condition) throws NXException, RemoteException
Condition.hasUserSpecifiedValue()
on the
specified Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionNXException
RemoteException
void setHasUserSpecifiedValueForCondition(Condition condition, boolean isUserSpecified) throws NXException, RemoteException
Condition.hasUserSpecifiedValue()
on the
specified Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionisUserSpecified
- Whether the condition's value should be user-specifiedNXException
RemoteException
String getUserPromptOfCondition(Condition condition) throws NXException, RemoteException
Condition.userPrompt()
of the
specified Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionNXException
RemoteException
void setUserPromptOfCondition(Condition condition, String userPrompt) throws NXException, RemoteException
Condition.userPrompt()
of the
specified Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionuserPrompt
- The user-promptNXException
RemoteException
String getDescriptionOfCondition(Condition condition) throws NXException, RemoteException
Condition.description()
of the
specified Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditionNXException
RemoteException
void setDescriptionOfCondition(Condition condition, String description) throws NXException, RemoteException
Condition.description()
of the
specified Condition
.
Only valid for a Condition
whose
Condition.type()
is Condition.TypeOption.VALUE_CONDITION
condition
- The conditiondescription
- The descriptionNXException
RemoteException
Classifier.TypeOption getClassifierTypeOfRule(Rule rule) throws NXException, RemoteException
Classifier.TypeOption
for the active Classifier
in this Rule
.
rule
- The ruleNXException
RemoteException
Classifier setClassifierTypeOfRule(Rule rule, Classifier.TypeOption classifierType) throws NXException, RemoteException
Classifier.TypeOption
for the active Classifier
in this Rule
.
Note that the old Classifier
in this Rule
will be deleted
and a new Classifier
will be created and set as the active Classifier
in this Rule
.
rule
- The ruleclassifierType
- The classifier type being setNXException
RemoteException
Property getReportingPropertyOfRule(Rule rule) throws NXException, RemoteException
Property
for the active Classifier
in this Rule
.
rule
- The ruleNXException
RemoteException
void setReportingPropertyOfRule(Rule rule, Property reportingProperty) throws NXException, RemoteException
Property
for the active Classifier
in this Rule
.
If the reporting Property
of the rule is set to null, then it is deleted.
Only valid for a Classifier
in this Rule
whose
Classifier.TypeOption
is Classifier.TypeOption.VALUE
or Classifier.TypeOption.RANGE
.
rule
- The rulereportingProperty
- The property being setNXException
RemoteException
Property.DatatypeOption getReportingDatatypeOfRule(Rule rule) throws NXException, RemoteException
Property.DatatypeOption
of the active Classifier
's reporting Property
in this Rule
.
rule
- The ruleNXException
RemoteException
void setReportingDatatypeOfRule(Rule rule, Property.DatatypeOption datatype) throws NXException, RemoteException
Property.DatatypeOption
of the active Classifier
's reporting Property
in this Rule
.
However datatype must not be Property.DatatypeOption.UNKNOWN
.
rule
- The ruledatatype
- The datatype being setNXException
RemoteException
void removeFilterConditionFromRule(Rule rule) throws NXException, RemoteException
Condition
from this rule. This will not delete
the condition.
rule
- The ruleNXException
RemoteException
Condition getFilterConditionOfRule(Rule rule) throws NXException, RemoteException
rule
- The ruleNXException
RemoteException
void setFilterConditionOfRule(Rule rule, Condition filterCondition) throws NXException, RemoteException
Condition
from this rule. Setting this will delete
any existing Rule.filterCondition()
and all of its children
(except it won't delete the replacement Condition
being set
by this call).
rule
- The rulefilterCondition
- The filter condition being setNXException
RemoteException
boolean getManualGroupingForRule(Rule rule) throws NXException, RemoteException
Classifier.GroupingMethodOption
of the active Classifier
in this Rule
is Classifier.GroupingMethodOption.MANUAL
.
rule
- The ruleNXException
RemoteException
void setManualGroupingForRule(Rule rule, boolean isManualGrouping) throws NXException, RemoteException
Classifier.GroupingMethodOption
of the active Classifier
in this Rule
is Classifier.GroupingMethodOption.MANUAL
.
If it uses Classifier.GroupingMethodOption.MANUAL
, then no
GroupLabel
s will be automatically generated, and they should
instead be added manually as required using createGroupLabel(java.lang.String, nxopen.visualreporting.Rule, nxopen.visualreporting.GroupLabel)
.
rule
- The ruleisManualGrouping
- Whether manual grouping should be usedNXException
RemoteException
Classifier.GroupingMethodOption getGroupingMethodOfRule(Rule rule) throws NXException, RemoteException
Classifier.GroupingMethodOption
of the active Classifier
in this Rule
.
rule
- The ruleNXException
RemoteException
void setGroupingMethodOfRule(Rule rule, Classifier.GroupingMethodOption groupingMethod) throws NXException, RemoteException
Classifier.GroupingMethodOption
of the active Classifier
in the given Rule
.
If the active Classifier
uses manual grouping then no GroupLabel
s
will be automatically generated, and they should instead be added using createGroupLabel(java.lang.String, nxopen.visualreporting.Rule, nxopen.visualreporting.GroupLabel)
.
rule
- The rulegroupingMethod
- The grouping methodNXException
RemoteException
Classifier.RangeMethodOption getRangeMethodOfRule(Rule rule) throws NXException, RemoteException
Classifier.RangeMethodOption
of the active Classifier
in the given Rule
.
Only valid if the active Classifier
in the rule
is Classifier.TypeOption.RANGE
type.
rule
- The ruleNXException
RemoteException
void setRangeMethodOfRule(Rule rule, Classifier.RangeMethodOption rangeMethod) throws NXException, RemoteException
Classifier.RangeMethodOption
of the active Classifier
in the given Rule
.
Only valid if the active Classifier
in the rule
is Classifier.TypeOption.RANGE
type.
rule
- The rulerangeMethod
- The range methodNXException
RemoteException
GroupLabel[] getAllGroupLabelsOfRule(Rule rule) throws NXException, RemoteException
GroupLabel
s associated with the active Classifier
in this Rule
.
rule
- The ruleNXException
RemoteException
GroupLabel getManualGroupLabelOfRule(Rule rule, int index) throws NXException, RemoteException
GroupLabel
s associated with the active Classifier
in this Rule
which are manually defined.
rule
- The ruleindex
- NXException
RemoteException
GroupLabel[] getManualGroupLabelsOfRule(Rule rule) throws NXException, RemoteException
GroupLabel
s associated with the active Classifier
in this Rule
which are manually defined.
rule
- The ruleNXException
RemoteException
void deleteGroupLabel(Rule rule, GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel
from the active Classifier
in this Rule
.
rule
- The rule containing the group labelgroupLabel
- The group labelNXException
RemoteException
void unsetUserNameOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel.isNameUserSpecified()
status of the given GroupLabel
so that the name is now
system-generated.
groupLabel
- The group labelNXException
RemoteException
String getUserNameOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
groupLabel
- The group labelNXException
RemoteException
void setUserNameOfGroupLabel(GroupLabel groupLabel, String name) throws NXException, RemoteException
INXObject.name()
of the given GroupLabel
. Calling this function
will cause GroupLabel.isNameUserSpecified()
to return true.
groupLabel
- The group labelname
- The nameNXException
RemoteException
String getLowerBoundOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel.lowerBound()
of the given GroupLabel
.
groupLabel
- The group labelNXException
RemoteException
void setLowerBoundOfGroupLabel(GroupLabel groupLabel, String lowerBound) throws NXException, RemoteException
GroupLabel.lowerBound()
of the given GroupLabel
.
groupLabel
- The group labellowerBound
- The lower boundNXException
RemoteException
String getUpperBoundOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel.upperBound()
of the given GroupLabel
.
groupLabel
- The group labelNXException
RemoteException
void setUpperBoundOfGroupLabel(GroupLabel groupLabel, String upperBound) throws NXException, RemoteException
GroupLabel.upperBound()
of the given GroupLabel
.
groupLabel
- The group labelupperBound
- The upper boundNXException
RemoteException
String getValueOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel.value()
of the given GroupLabel
.
groupLabel
- The group labelNXException
RemoteException
void setValueOfGroupLabel(GroupLabel groupLabel, String value) throws NXException, RemoteException
GroupLabel.value()
of the given GroupLabel
.
groupLabel
- The group labelvalue
- The valueNXException
RemoteException
GroupLabel.DisplayStyleOption getDisplayStyleForGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel.DisplayStyleOption
of the given GroupLabel
groupLabel
- The group labelNXException
RemoteException
void setDisplayStyleForGroupLabel(GroupLabel groupLabel, GroupLabel.DisplayStyleOption displayStyle) throws NXException, RemoteException
GroupLabel.DisplayStyleOption
of the given GroupLabel
groupLabel
- The group labeldisplayStyle
- The display styleNXException
RemoteException
NXColor.Rgb getColorOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
GroupLabel.color()
of the given GroupLabel
.
groupLabel
- The group labelNXException
RemoteException
void setColorOfGroupLabel(GroupLabel groupLabel, NXColor.Rgb color) throws NXException, RemoteException
GroupLabel.color()
of the given GroupLabel
. This also changes
GroupLabel.displayStyle()
to GroupLabel.DisplayStyleOption.SPECIFIED_COLOR
.
groupLabel
- The group labelcolor
- The colorNXException
RemoteException
String getBitmapNameOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
groupLabel
- The group labelNXException
RemoteException
void setBitmapNameOfGroupLabel(GroupLabel groupLabel, String bitmapName) throws NXException, RemoteException
groupLabel
- The group labelbitmapName
- The bitmap nameNXException
RemoteException
String getCustomMessageOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
groupLabel
- The group labelNXException
RemoteException
void setCustomMessageOfGroupLabel(GroupLabel groupLabel, String customMessage) throws NXException, RemoteException
groupLabel
- The group labelcustomMessage
- The bitmap nameNXException
RemoteException
Property createProperty(Property.TypeOption propertyType) throws NXException, RemoteException
Property
, but does not add it to a
VisualReport
.
propertyType
- Property Type of the Property
being createdNXException
RemoteException
void deleteProperty(Property property) throws NXException, RemoteException
Property
which has no owner. Before call this function,
User must be sure there is no reference to this object
property
- The property to be deletedNXException
RemoteException
Condition createAndCondition() throws NXException, RemoteException
Condition
, but does not add it to a
Rule
.
NXException
RemoteException
Condition createOrCondition() throws NXException, RemoteException
Condition
, but does not add it to a
Rule
.
NXException
RemoteException
Condition createNotCondition() throws NXException, RemoteException
Condition
, but does not add it to a
Rule
.
NXException
RemoteException
Condition createStringCondition(Property property, String value, Condition.OperatorOption operatorType) throws NXException, RemoteException
Condition
whose
Condition.datatype()
is
Property.DatatypeOption.STRING
,
but does not add it to a Rule
.
property
- The Property
to which this condition will be appliedvalue
- The initial valueoperatorType
- The initial operatorNXException
RemoteException
Condition createIntegerCondition(Property property, int value, Condition.OperatorOption operatorType) throws NXException, RemoteException
Condition
whose
Condition.datatype()
is
Property.DatatypeOption.INTEGER
,
but does not add it to a Rule
.
property
- The Property
to which this condition will be appliedvalue
- The initial valueoperatorType
- The initial operatorNXException
RemoteException
Condition createRealCondition(Property property, double value, Condition.OperatorOption operatorType, double tolerance) throws NXException, RemoteException
Condition
whose
Condition.datatype()
is
Property.DatatypeOption.REAL
,
but does not add it to a Rule
.
property
- The Property
to which this condition will be appliedvalue
- The initial valueoperatorType
- The initial operatortolerance
- The tolerance used in comparisonsNXException
RemoteException
Condition createBooleanCondition(Property property, boolean value, Condition.OperatorOption operatorType) throws NXException, RemoteException
Condition
whose
Condition.datatype()
is
Property.DatatypeOption.BOOLEAN
,
but does not add it to a Rule
.
property
- The Property
to which this condition will be appliedvalue
- The initial valueoperatorType
- The initial operatorNXException
RemoteException
Condition createNullCondition(Property property, boolean value, Condition.OperatorOption operatorType) throws NXException, RemoteException
Condition
whose
Condition.datatype()
is
Property.DatatypeOption.NULL
,
but does not add it to a Rule
.
property
- The Property
to which this condition will be appliedvalue
- The initial valueoperatorType
- The initial operatorNXException
RemoteException
Condition createDateCondition(Property property, String value, Condition.OperatorOption operatorType) throws NXException, RemoteException
Condition
whose
Condition.datatype()
is
Property.DatatypeOption.DATE
,
but does not add it to a Rule
.
property
- The Property
to which this condition will be appliedvalue
- The initial valueoperatorType
- The initial operatorNXException
RemoteException
Condition getParentCondition(Condition condition) throws NXException, RemoteException
Condition
. If this
condition has no parent or if the parent isn't a condition
then this returns null.
condition
- NXException
RemoteException
boolean isChildCondition(Condition condition, Condition childCondition) throws NXException, RemoteException
Condition
is an immediate child of this condition
condition
- childCondition
- The possible child ConditionNXException
RemoteException
Condition getChildCondition(Condition condition, int index) throws NXException, RemoteException
Condition
from this Condition
condition
- index
- The index of the returned Condition.NXException
RemoteException
Condition[] getChildConditions(Condition condition) throws NXException, RemoteException
condition
- NXException
RemoteException
GroupLabel createGroupLabel(String name, Rule rule, GroupLabel afterGroupLabel) throws NXException, RemoteException
GroupLabel
, and adds it to the given
Rule
. This can only be called if the active Classifier
in this rule is using Classifier.GroupingMethodOption.MANUAL
grouping.
name
- The initial name. If this name is empty then a system-generated name will be
assigned when the owning VisualReport
is next activatedrule
- The rule to which to add itafterGroupLabel
- The group label after which to add it. If null then it is inserted
at the beginning before any existing group labelsNXException
RemoteException
String keywordsOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this
builder.
NXException
RemoteException
void setKeywordsOfVisualReport(String keywords) throws NXException, RemoteException
keywords
- A comma separated string of keywordsNXException
RemoteException
String descriptiveCategoryOfVisualReport() throws NXException, RemoteException
VisualReport
being built by this builder.
NXException
RemoteException
void setDescriptiveCategoryOfVisualReport(String category) throws NXException, RemoteException
category
- The category being setNXException
RemoteException
void setPropertySpecification(Property property, String key) throws NXException, RemoteException
Property
being built by this builder.
property
- The property being setkey
- property keyNXException
RemoteException
void setPropertySpecification(Property property, String key, String name) throws NXException, RemoteException
Property
being built by this builder.
property
- The property being setkey
- property keyname
- property nameNXException
RemoteException
VisualReportBuilder.PropertySpecificationData getPropertySpecification(Property property) throws NXException, RemoteException
Property
being built by this builder.
property
- The property being askNXException
RemoteException
String bitmapNameOfReport() throws NXException, RemoteException
NXException
RemoteException
void setBitmapNameOfReport(String bitmapName) throws NXException, RemoteException
bitmapName
- The bitmap nameNXException
RemoteException
String customMessageOfReport() throws NXException, RemoteException
NXException
RemoteException
void setCustomMessageOfReport(String customMessage) throws NXException, RemoteException
customMessage
- The custom messageNXException
RemoteException
VisualReportBuilder.ReferencePropertiesOfReportData getReferencePropertiesOfReport() throws NXException, RemoteException
NXException
RemoteException
void setReferencePropertiesOfReport(Property[] properties, VisualReportBuilder.PropertyUsageOption[] usages) throws NXException, RemoteException
properties
- The reference properties of reportusages
- The usages of reportNXException
RemoteException
VisualReport.SaveDestinationOption saveDestination() throws NXException, RemoteException
VisualReport.SaveDestinationOption
of the VisualReport
being built by this
builder.
Note that this property will always be VisualReport.SaveDestinationOption.LOCAL
when NX is not connected to Teamcenter.
NXException
RemoteException
void setSaveDestination(VisualReport.SaveDestinationOption destinationOption) throws NXException, RemoteException
destinationOption
- The destination optionNXException
RemoteException
String destinationTeamcenterFolder() throws NXException, RemoteException
VisualReport
being built by this
builder to Teamcenter database.
Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database.
This VisualReport.destinationTeamcenterFolder()
may return null if you haven't
set a folder name on this property.
NXException
RemoteException
void setDestinationTeamcenterFolder(String foldername) throws NXException, RemoteException
foldername
- The Teamcenter folder nameNXException
RemoteException
void save() throws NXException, RemoteException
VisualReport
to its current filenameOfVisualReport()
.
Note that when NX is connected to Teamcenter, the filenameOfVisualReport()
will be
updated to the report dataset identifier after the report is saved to Teamcenter database.
NXException
RemoteException
GroupLabel.TagPriorityOption getTagPriorityOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
groupLabel
- The group labelNXException
RemoteException
void setTagPriorityOfGroupLabel(GroupLabel groupLabel, GroupLabel.TagPriorityOption tagPriority) throws NXException, RemoteException
groupLabel
- The group labeltagPriority
- The priorityNXException
RemoteException
Validation.Result getErrorLevelOfGroupLabel(GroupLabel groupLabel) throws NXException, RemoteException
groupLabel
- The group labelNXException
RemoteException
void setErrorLevelOfGroupLabel(GroupLabel groupLabel, Validation.Result errorLevel) throws NXException, RemoteException
groupLabel
- The group labelerrorLevel
- The error levelNXException
RemoteException
void deleteChildCondition(Condition condition, Condition childCondition) throws NXException, RemoteException
Condition
from its parent condition.
If there are Property
s associated with this condition, these properties will be deleted.
If there are child conditions associated with this condtion, these child conditions will be deleted too.
condition
- The conditionchildCondition
- The child condition being removedNXException
RemoteException
Classifier.DateGroupMethodOption getDateGroupMethodOfRule(Rule rule) throws NXException, RemoteException
Classifier.DateGroupMethodOption
of the active Classifier
in the given Rule
.
Only valid if the active Classifier
in the rule
is Classifier.TypeOption.RANGE
type.
rule
- The ruleNXException
RemoteException
void setDateGroupMethodOfRule(Rule rule, Classifier.DateGroupMethodOption dateGroupMethod) throws NXException, RemoteException
Classifier.DateGroupMethodOption
of the active Classifier
in the given Rule
.
Only valid if the active Classifier
in the rule
is Classifier.TypeOption.RANGE
type.
rule
- The ruledateGroupMethod
- The range methodNXException
RemoteException
VisualReport.ScopeTypeOption scopeTypeOfVisualReport() throws NXException, RemoteException
VisualReport.ScopeTypeOption
of the VisualReport
being built by this builder.
NXException
RemoteException
void setScopeTypeOfVisualReport(VisualReport.ScopeTypeOption scopeType) throws NXException, RemoteException
scopeType
- NXException
RemoteException
VisualReport.ObjectTypeOption[] getObjectTypesOfVisualReport() throws NXException, RemoteException
VisualReport.ObjectTypeOption
s of the VisualReport
being built by this builder.
Only valid if the VisualReport.scopeType()
of the VisualReport
is VisualReport.ScopeTypeOption.SUB_PART
type.
NXException
RemoteException
void setObjectTypesOfVisualReport(VisualReport.ObjectTypeOption[] objectTypes) throws NXException, RemoteException
VisualReport.ObjectTypeOption
s of the VisualReport
being built by this builder.
Only valid if the VisualReport.scopeType()
of the VisualReport
is VisualReport.ScopeTypeOption.SUB_PART
type.
objectTypes
- The object types being setNXException
RemoteException
VisualReport.ReportContextOption reportContextOfVisualReport() throws NXException, RemoteException
VisualReport.reportContext()
instead.
VisualReport.ReportContextOption
of the VisualReport
being built by this builder.
NXException
RemoteException
void setReportContextOfVisualReport(VisualReport.ReportContextOption reportContext) throws NXException, RemoteException
VisualReport.setReportContext(nxopen.visualreporting.VisualReport.ReportContextOption)
instead.
reportContext
- The report context being set
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.