Interface ITDFilter
-
- All Superinterfaces:
com4j.Com4jObject
- All Known Subinterfaces:
IHierarchyFilter
,ITDFilter2
public interface ITDFilter extends com4j.Com4jObject
Services for creation of a filtered list of field objects without SQL.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
_Text()
Getter method for the COM property "_Text"void
_Text(java.lang.String pVal)
Setter method for the COM property "_Text"boolean
caseSensitive(java.lang.String fieldName)
Indicates if the filter for the specified field is case sensitive.void
caseSensitive(java.lang.String fieldName, boolean pVal)
Indicates if the filter for the specified field is case sensitive.void
clear()
Clears the current filter.java.lang.String
dataType()
The filtered entity type.IList
fields()
The list of fields for the TDFilter's parent object.java.lang.Object
fields(int index)
java.lang.String
filter(java.lang.String fieldName)
The filter condition for the field specified by the FieldName.void
filter(java.lang.String fieldName, java.lang.String pVal)
The filter condition for the field specified by the FieldName.IList
newList()
Creates a new list from current filter.java.lang.Object
newList(int index)
int
order(java.lang.String fieldName)
The position of the specified field in the list of the sort fields.void
order(java.lang.String fieldName, int pVal)
The position of the specified field in the list of the sort fields.short
orderDirection(java.lang.String fieldName)
The sort order: TDOLE_ASCENDING or TDOLE_DESCENDING.void
orderDirection(java.lang.String fieldName, short pVal)
The sort order: TDOLE_ASCENDING or TDOLE_DESCENDING.void
refresh()
Reads saved data and refreshes the fetched list according to the current filter, overwriting values in memory.java.lang.String
text()
The full fields filter as text.void
text(java.lang.String pVal)
The full fields filter as text.java.lang.String
uFilter(java.lang.String entityType)
For HP use.void
uFilter(java.lang.String entityType, java.lang.String pVal)
For HP use.java.lang.String
xFilter(java.lang.String crossEntity)
The cross filter according to the entity type.void
xFilter(java.lang.String crossEntity, java.lang.String pVal)
The cross filter according to the entity type.
-
-
-
Method Detail
-
_Text
java.lang.String _Text()
Getter method for the COM property "_Text"
- Returns:
- Returns a value of type java.lang.String
-
_Text
void _Text(java.lang.String pVal)
Setter method for the COM property "_Text"
- Parameters:
pVal
- Mandatory java.lang.String parameter.
-
filter
java.lang.String filter(java.lang.String fieldName)
The filter condition for the field specified by the FieldName.
Getter method for the COM property "Filter"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type java.lang.String
-
filter
void filter(java.lang.String fieldName, java.lang.String pVal)
The filter condition for the field specified by the FieldName.
Setter method for the COM property "Filter"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.pVal
- Mandatory java.lang.String parameter.
-
order
int order(java.lang.String fieldName)
The position of the specified field in the list of the sort fields. (zero-based).
Getter method for the COM property "Order"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type int
-
order
void order(java.lang.String fieldName, int pVal)
The position of the specified field in the list of the sort fields. (zero-based).
Setter method for the COM property "Order"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.pVal
- Mandatory int parameter.
-
orderDirection
short orderDirection(java.lang.String fieldName)
The sort order: TDOLE_ASCENDING or TDOLE_DESCENDING.
Getter method for the COM property "OrderDirection"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type short
-
orderDirection
void orderDirection(java.lang.String fieldName, short pVal)
The sort order: TDOLE_ASCENDING or TDOLE_DESCENDING.
Setter method for the COM property "OrderDirection"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.pVal
- Mandatory short parameter.
-
clear
void clear()
Clears the current filter.
-
newList
IList newList()
Creates a new list from current filter.
- Returns:
- Returns a value of type step.repository.alm.v16.otaclient.IList
-
newList
java.lang.Object newList(int index)
-
fields
IList fields()
The list of fields for the TDFilter's parent object.
Getter method for the COM property "Fields"
- Returns:
- Returns a value of type step.repository.alm.v16.otaclient.IList
-
fields
java.lang.Object fields(int index)
-
refresh
void refresh()
Reads saved data and refreshes the fetched list according to the current filter, overwriting values in memory.
-
caseSensitive
boolean caseSensitive(java.lang.String fieldName)
Indicates if the filter for the specified field is case sensitive. The default is False.
Getter method for the COM property "CaseSensitive"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type boolean
-
caseSensitive
void caseSensitive(java.lang.String fieldName, boolean pVal)
Indicates if the filter for the specified field is case sensitive. The default is False.
Setter method for the COM property "CaseSensitive"
- Parameters:
fieldName
- Mandatory java.lang.String parameter.pVal
- Mandatory boolean parameter.
-
text
java.lang.String text()
The full fields filter as text.
Getter method for the COM property "Text"
- Returns:
- Returns a value of type java.lang.String
-
text
void text(java.lang.String pVal)
The full fields filter as text.
Setter method for the COM property "Text"
- Parameters:
pVal
- Mandatory java.lang.String parameter.
-
xFilter
java.lang.String xFilter(java.lang.String crossEntity)
The cross filter according to the entity type.
Getter method for the COM property "XFilter"
- Parameters:
crossEntity
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type java.lang.String
-
xFilter
void xFilter(java.lang.String crossEntity, java.lang.String pVal)
The cross filter according to the entity type.
Setter method for the COM property "XFilter"
- Parameters:
crossEntity
- Mandatory java.lang.String parameter.pVal
- Mandatory java.lang.String parameter.
-
uFilter
java.lang.String uFilter(java.lang.String entityType)
For HP use. The Union Filter according to the entity type.
Getter method for the COM property "UFilter"
- Parameters:
entityType
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type java.lang.String
-
uFilter
void uFilter(java.lang.String entityType, java.lang.String pVal)
For HP use. The Union Filter according to the entity type.
Setter method for the COM property "UFilter"
- Parameters:
entityType
- Mandatory java.lang.String parameter.pVal
- Mandatory java.lang.String parameter.
-
dataType
java.lang.String dataType()
The filtered entity type.
Getter method for the COM property "DataType"
- Returns:
- Returns a value of type java.lang.String
-
-