public interface Condition extends NXObject
Modifier and Type | Interface and Description |
---|---|
static class |
Condition.OperatorOption
Represents the possible operator type options.
|
static class |
Condition.TypeOption
Represents the possible type options
for a
Condition . |
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
Property.DatatypeOption |
datatype()
Returns the
Property.DatatypeOption of this Condition . |
String |
description()
Returns the description for this
Condition . |
Condition |
getChildCondition(int index)
Return the specified child Condition from this
Condition
License requirements: None. |
Condition[] |
getChildConditions()
Returns all the child Conditions in this
Condition
License requirements: None. |
boolean |
hasUserSpecifiedValue()
Returns whether this
Condition requires user input. |
boolean |
isChildCondition(Condition childCondition)
Returns whether the given
Condition is an immediate child of this condition
License requirements: None. |
Condition.OperatorOption |
operatorType()
Returns the
Condition.OperatorOption of this Condition . |
Condition |
parentCondition()
Returns the parent condition of this
Condition . |
Property |
property()
|
void |
setDescription(String description)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setHasUserSpecifiedValue(boolean isUserSpecified)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setOperatorType(Condition.OperatorOption operatorType)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setProperty(Property property)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setUserPrompt(String userPrompt)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setValue(String conditionValue)
License requirements: nx_visual_reporting ("Visual Reporting") . |
Condition.TypeOption |
type()
|
String |
userPrompt()
Returns the user prompt for this
Condition . |
String |
value()
Returns the value of this
Condition . |
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
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
Condition.TypeOption type() throws NXException, RemoteException
Condition.TypeOption
of this Condition
Note that this type()
cannot be modified.
Instead it is determined when creating this Condition
by using the appropriate function:
- VisualReportBuilder.createStringCondition(nxopen.visualreporting.Property, java.lang.String, nxopen.visualreporting.Condition.OperatorOption)
- VisualReportBuilder.createIntegerCondition(nxopen.visualreporting.Property, int, nxopen.visualreporting.Condition.OperatorOption)
- VisualReportBuilder.createRealCondition(nxopen.visualreporting.Property, double, nxopen.visualreporting.Condition.OperatorOption, double)
- VisualReportBuilder.createBooleanCondition(nxopen.visualreporting.Property, boolean, nxopen.visualreporting.Condition.OperatorOption)
- VisualReportBuilder.createAndCondition()
- VisualReportBuilder.createOrCondition()
- VisualReportBuilder.createNotCondition()
NXException
RemoteException
Property property() throws NXException, RemoteException
Property
of this Condition
. If the
nxopen.VisualReporting#property
is set to null, then it is
deleted.
Only valid for a Condition
whose
type()
is Condition.TypeOption.VALUE_CONDITION
NXException
RemoteException
void setProperty(Property property) throws NXException, RemoteException
property
- NXException
RemoteException
Property.DatatypeOption datatype() throws NXException, RemoteException
Property.DatatypeOption
of this Condition
.
The returned data type will never be
Property.DatatypeOption.UNKNOWN
.
Note that this datatype()
cannot be modified.
Instead it is specified when creating this Condition
by using the appropriate function:
- VisualReportBuilder.createStringCondition(nxopen.visualreporting.Property, java.lang.String, nxopen.visualreporting.Condition.OperatorOption)
- VisualReportBuilder.createIntegerCondition(nxopen.visualreporting.Property, int, nxopen.visualreporting.Condition.OperatorOption)
- VisualReportBuilder.createRealCondition(nxopen.visualreporting.Property, double, nxopen.visualreporting.Condition.OperatorOption, double)
- VisualReportBuilder.createBooleanCondition(nxopen.visualreporting.Property, boolean, nxopen.visualreporting.Condition.OperatorOption)
Note that the Condition
s created using the following functions do not
have Property.DatatypeOption
s and calling this function will cause an error for these:
- VisualReportBuilder.createAndCondition()
- VisualReportBuilder.createOrCondition()
- VisualReportBuilder.createNotCondition()
NXException
RemoteException
boolean hasUserSpecifiedValue() throws NXException, RemoteException
Condition
requires user input.
Only valid for a Condition
whose
type()
is Condition.TypeOption.VALUE_CONDITION
NXException
RemoteException
void setHasUserSpecifiedValue(boolean isUserSpecified) throws NXException, RemoteException
isUserSpecified
- NXException
RemoteException
String userPrompt() throws NXException, RemoteException
Condition
. Only useful for a condition where
hasUserSpecifiedValue()
is true.
Only valid for a Condition
whose
type()
is Condition.TypeOption.VALUE_CONDITION
NXException
RemoteException
void setUserPrompt(String userPrompt) throws NXException, RemoteException
userPrompt
- NXException
RemoteException
String description() throws NXException, RemoteException
Condition
.
Only valid for a Condition
whose
type()
is Condition.TypeOption.VALUE_CONDITION
NXException
RemoteException
void setDescription(String description) throws NXException, RemoteException
description
- NXException
RemoteException
String value() throws NXException, RemoteException
Condition
.
Only valid for a Condition
whose
type()
is Condition.TypeOption.VALUE_CONDITION
NXException
RemoteException
void setValue(String conditionValue) throws NXException, RemoteException
conditionValue
- NXException
RemoteException
Condition.OperatorOption operatorType() throws NXException, RemoteException
Condition.OperatorOption
of this Condition
.
Only valid for a Condition
whose
type()
is Condition.TypeOption.VALUE_CONDITION
NXException
RemoteException
void setOperatorType(Condition.OperatorOption operatorType) throws NXException, RemoteException
operatorType
- NXException
RemoteException
Condition parentCondition() throws NXException, RemoteException
Condition
. If this
condition has no parent or if the parent isn't a condition
then this returns null.
Note that this parentCondition()
cannot be modified.
Instead it is determined when inserting this Condition
in the Rule
by using the appropriate function:
- VisualReportBuilder.setFilterConditionOfRule(nxopen.visualreporting.Rule, nxopen.visualreporting.Condition)
- VisualReportBuilder.addChildToCondition(nxopen.visualreporting.Condition, nxopen.visualreporting.Condition)
NXException
RemoteException
boolean isChildCondition(Condition childCondition) throws NXException, RemoteException
Condition
is an immediate child of this condition
childCondition
- The possible child ConditionNXException
RemoteException
Condition getChildCondition(int index) throws NXException, RemoteException
Condition
index
- The index of the returned Condition.NXException
RemoteException
Condition[] getChildConditions() throws NXException, RemoteException
NXException
RemoteException
Copyright 2016 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.