public interface CSOSearchCondition
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ClassificationCondition
Used to mark the condition to be a Classification condition.
|
static java.lang.String |
ComparisonCondition
Used to mark the condition to be a comparison condition.
|
static java.lang.String |
CustomCondition
Used to mark the condition to be a custom condition.
|
static java.lang.String |
KeywordCondition
Used to mark the condition to be a keyword condition.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Overrides the clone() method from
Object . |
CentraSiteObjectAttribute |
getAttribute()
Returns the CSOAttribute addressed by the condition.
|
java.lang.String |
getDisplayName()
Retrieves the display name of the condition .
|
java.lang.String |
getName()
Retrieves the name of the condition.
|
Operator |
getOperator()
Returns the condition operator.
|
java.lang.String |
getPredicate()
Returns a String holding the query fragment representing the condition.
|
java.util.List<?> |
getValues()
Returns the parameters of the condition.
|
void |
setAttribute(CentraSiteObjectAttribute attribute)
Sets the CSOAttribute for the condition.
|
void |
setOperator(Operator operator)
Sets the condition operator from predefined enum.
|
void |
setOperator(java.lang.String operatorName)
Sets the condition operator from a string.
|
void |
setPredicate(java.lang.String predicate)
Assigns a string holding the query fragment to the condition.
|
void |
setValues(java.util.List<?> values)
Sets the parameter of the condition.
|
static final java.lang.String KeywordCondition
static final java.lang.String ComparisonCondition
static final java.lang.String CustomCondition
static final java.lang.String ClassificationCondition
java.lang.String getName()
java.lang.String getDisplayName()
java.lang.String getPredicate() throws CLLException
CLLException
- If an error occurs in fetching the predicatevoid setPredicate(java.lang.String predicate) throws CLLException
predicate
- String holding the query fragmentCLLException
- If an error occurs in setting the predicateCentraSiteObjectAttribute getAttribute()
CentraSiteObjectAttribute
on which the condition is definedvoid setAttribute(CentraSiteObjectAttribute attribute) throws CLLException
attribute
- The CentraSiteObjectAttribute
to setCLLException
- If an error occurs in setting the attributeOperator getOperator()
Operator
which is used in this CSOSearchConditionvoid setOperator(Operator operator) throws CLLException
operator
- enum that specifies the Operator
to be used for this CSOSearchConditionCLLException
- If an error occurs in setting the operatorvoid setOperator(java.lang.String operatorName) throws CLLException
operatorName
- The string name of the condition operatorCLLException
- In the given string operatorName does not have an Operator
equivalentjava.util.List<?> getValues()
List
of values that are used in current CSOSearchConditionvoid setValues(java.util.List<?> values) throws CLLException
values
- List
of values that are to be used in current CSOSearchConditionCLLException
- If an error occurs in setting the valuesjava.lang.Object clone() throws java.lang.CloneNotSupportedException
Object
.java.lang.CloneNotSupportedException
- If the object's class does not support the Cloneable
interface