public interface IDfSearchTypeAssistant
Modifier and Type | Method and Description |
---|---|
int |
getAttrDataType(java.lang.String attrName)
Retrieves the datatype of an attribute.
|
java.lang.String |
getAttributeLabel(java.lang.String attrName)
Retrieves a localized attribute label for a given attribute.
|
IDfEnumeration |
getAttributeNames()
Retrieves an enumeration of the names of the searchable attributes for the type.
|
java.lang.String |
getDefaultAttribute()
Provides access to a default attribute for the type.
|
java.lang.String |
getDefaultSearchOp(java.lang.String attrName)
Retrieves the default search operation as a string code (such as "10", "1", ...) for an attribute.
|
java.lang.String |
getDefaultValue(java.lang.String attrName)
Retrieves the default search value for the specified attribute.
|
java.lang.String |
getDefaultValue(java.lang.String attrName,
java.lang.String searchOp)
Deprecated.
|
java.lang.String |
getSearchOpLabel(java.lang.String attrName,
java.lang.String searchOp)
Retrieves a localized search operation label (such as "Greater than", "Equal", ...) for a given search operation
code.
|
IDfEnumeration |
getSearchOpLabels(java.lang.String attrName)
Retrieves an enumeration of the localized search operation labels (such as "Greater than", "Equal", ...).
|
IDfEnumeration |
getSearchOps(java.lang.String attrName)
Retrieves an enumeration of search operations as string codes (such as "10", "1", ...).
|
java.lang.String |
getSuperName()
Gets the super-type name.
|
IDfType |
getType()
Returns a read only copy of IDfType object disconnected from the current session.
|
java.lang.String |
getTypeLabel()
Gets the type label.
|
java.lang.String |
getTypeName()
Gets the type name.
|
IDfValueAssistance |
getValueAssistance(IDfExpression rootExpr,
IDfAttrExpression vaExpr)
Gets the value assistance of an attribute with dependencies to other attributes values.
|
IDfValueAssistance |
getValueAssistance(java.lang.String attrName)
Gets the value assistance of an attribute without dependencies to other attributes values.
|
java.lang.String |
getValueLabel(java.lang.String attrName,
java.lang.String searchOp,
java.lang.String value)
Deprecated.
|
IDfEnumeration |
getValues(java.lang.String attrName,
java.lang.String searchOp)
Deprecated.
|
boolean |
hasAttribute(java.lang.String attribute)
Checks if an attribute is available on the type.
|
boolean |
hasValueAssistance(java.lang.String attrName)
Indicates whether a value assistance is available for an attribute.
|
boolean |
hasValueAssistanceDependencies(java.lang.String attrName)
Indicates whether the value assistance of an attribute defines dependencies on other attributes values.
|
boolean |
isAttributeRepeated(java.lang.String attrName)
Tests if a given attribute is repeated.
|
boolean |
isFulltextCompliant()
Returns a boolean value indicating whether the type assistant is in a full-text compliant
mode.
|
void |
setFulltextCompliant(boolean fulltextCompliant)
Switches the mode for supporting only full-text compliant constructs.
|
java.lang.String getTypeName()
java.lang.String getTypeLabel() throws DfException
DfException
- If an error occurs while getting the label.IDfType getType() throws DfException
DfException
- If an error occurs while getting the type.java.lang.String getSuperName() throws DfException
DfException
- If an error occurs while getting the super-type.boolean isFulltextCompliant()
true
, if full-text compliance is requested; false
, otherwise.void setFulltextCompliant(boolean fulltextCompliant)
fulltextCompliant
- true
, if full-text compliance is requested; false
, otherwise.java.lang.String getDefaultAttribute() throws DfException
DfException
- If an error occurs while getting the default attribute.IDfEnumeration getAttributeNames() throws DfException
DfException
- If an error occurs while getting the attributes.boolean hasAttribute(java.lang.String attribute) throws DfException
getAttributeNames()
:
getAttributeNames()
returns only the searchable attributes. However non searchable attributes can still be retrieved (in results attributes for example).attribute
- The attribute name.true
, if the attribute is available; false
, otherwise.DfException
- If an error occurs while getting the attributes.java.lang.String getAttributeLabel(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.DfException
- If an error occurs while getting the attribute label.boolean isAttributeRepeated(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.true
, if the attribute is repeated; false
, otherwise.DfException
- If an error occurs while getting the attribute info.int getAttrDataType(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.DfException
- If an error occurs while getting the attribute info.java.lang.String getDefaultSearchOp(java.lang.String attrName) throws DfException
attrName
- The name of the inquired attribute.DfException
- If an error occurs while getting the default search operation.IDfEnumeration getSearchOps(java.lang.String attrName) throws DfException
attrName
- The name of the inquired attribute.DfException
- If an error occurs while getting the search operations.IDfEnumeration getSearchOpLabels(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.DfException
- If an error occurs while getting the search operations labels.java.lang.String getSearchOpLabel(java.lang.String attrName, java.lang.String searchOp) throws DfException
attrName
- The name of the attribute.searchOp
- The search operation.DfException
- If an error occurs while getting the search operation label.java.lang.String getDefaultValue(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.DfException
- If an error occurs while getting the default search value.java.lang.String getDefaultValue(java.lang.String attrName, java.lang.String searchOp) throws DfException
DfException
boolean hasValueAssistance(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.true
, if a value assistance is available; false
, otherwise.DfException
- If an error occurs while accessing the value assistance item.boolean hasValueAssistanceDependencies(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.true
, if a value assistance item defines dependencies to other attributes values;
false
, otherwise.DfException
- If an error occurs while accessing the value assistance setting.IDfValueAssistance getValueAssistance(java.lang.String attrName) throws DfException
attrName
- The name of the attribute.DfException
- If an error occurs while accessing the value assistance item.IDfValueAssistance getValueAssistance(IDfExpression rootExpr, IDfAttrExpression vaExpr) throws DfException
rootExpr
- The root of the search expression tree.vaExpr
- The specific search expression (within the expression tree) for which you want to find value assistance.DfException
- If an error occurs while accessing the value assistance item.IDfEnumeration getValues(java.lang.String attrName, java.lang.String searchOp) throws DfException
DfException
java.lang.String getValueLabel(java.lang.String attrName, java.lang.String searchOp, java.lang.String value) throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.