nxopen.visualreporting

Interface Rule

All Superinterfaces:

INXObject, NXObject, Remote, TaggedObject

public interface Rule
extends NXObject

A rule within a VisualReport .
Created in NX7.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
Classifier	activeClassifier() Returns the active Classifier in this Rule for a multiple properties report.
Condition	filterCondition() Returns the filter Condition from this Rule .
Classifier[]	getClassifiers() Returns the Classifier s associated with this Rule .
boolean	getIsSmartGroupDateEnabled(Classifier classifier) The Classifier.DateGroupMethodOption in this Classifier in the Rule will be determined by the overall date range of all reported objects.
void	setActiveClassifier(Classifier activeClassifier) License requirements: nx_visual_reporting ("Visual Reporting") .
void	setFilterCondition(Condition filterCondition) License requirements: nx_visual_reporting ("Visual Reporting") .
void	setIsSmartGroupDateEnabled(Classifier classifier, boolean isSmartGroupDateEnabled) The Classifier.DateGroupMethodOption in this Classifier in the Rule will be determined by the overall date range of all reported objects.

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

filterCondition

Condition filterCondition()
                   throws NXException,
                          RemoteException

Returns the filter Condition from this Rule .
License requirements: None.

Created in NX7.0.0

Throws:

NXException

RemoteException

setFilterCondition

void setFilterCondition(Condition filterCondition)
                 throws NXException,
                        RemoteException

License requirements: nx_visual_reporting ("Visual Reporting")
.
Created in NX8.0.0

Parameters:

filterCondition -

Throws:

NXException

RemoteException

getClassifiers

Classifier[] getClassifiers()
                     throws NXException,
                            RemoteException

Returns the Classifier s associated with this Rule .
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

activeClassifier

Classifier activeClassifier()
                     throws NXException,
                            RemoteException

Returns the active Classifier in this Rule for a multiple properties report.
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

setActiveClassifier

void setActiveClassifier(Classifier activeClassifier)
                  throws NXException,
                         RemoteException

License requirements: nx_visual_reporting ("Visual Reporting")
.
Created in NX8.0.0

Parameters:

activeClassifier -

Throws:

NXException

RemoteException

getIsSmartGroupDateEnabled

boolean getIsSmartGroupDateEnabled(Classifier classifier)
                            throws NXException,
                                   RemoteException

The Classifier.DateGroupMethodOption in this Classifier in the Rule will be determined by the overall date range of all reported objects. For example, if the date range spans over 18 monthes, group by year will be used, otherwise if it is over 3 months, group by month will be used. If the date range is small, within 2 weeks, group by day will be used. Only valid for a Classifier whose Classifier.GroupingMethodOption is Classifier.GroupingMethodOption.AUTOMATIC or Classifier.GroupingMethodOption.SEMI_AUTOMATIC and the Property.DatatypeOption on the Property is Property.DatatypeOption.DATE .
License requirements: None.

Created in NX8.5.0

Parameters:

classifier -

Throws:

NXException

RemoteException

setIsSmartGroupDateEnabled

void setIsSmartGroupDateEnabled(Classifier classifier,
                                boolean isSmartGroupDateEnabled)
                         throws NXException,
                                RemoteException

The Classifier.DateGroupMethodOption in this Classifier in the Rule will be determined by the overall date range of all reported objects.
License requirements: nx_visual_reporting ("Visual Reporting")

Created in NX8.5.0

Parameters:

classifier -

isSmartGroupDateEnabled -

Throws:

NXException

RemoteException