com.imc.context.filters

Interface FilterFactory

public interface FilterFactory

A factory which is responsible for creating data structures to support user filtering.

Method Summary

Modifier and Type	Method and Description
ConditionAggregate	createAggregateCondition()
ConditionAggregate	createAggregateConditionAND()
ConditionAggregate	createAggregateConditionOR()
Condition	getAllBDASearchCondition(Object value)
Condition	getCondition(BusinessAttribute attribute, Object value, Condition.OPERATOR operator) Get a new where condition based on a data attribute for user filtering.
Condition	getCondition(BusinessObject primaryBO, Condition.OPERATOR operator) Get a new where condition based on a business object for user filtering.
Condition	getCondition(BusinessType type) Get a new where condition based on a business type.
Condition	getCondition(BusinessType type, BusinessRelationAttribute attribute, BusinessAttribute objectField, Object value, Condition.OPERATOR operator) Get a new where condition based on a related object's business data attribute for user filtering.
Condition	getCondition(Collection<BusinessType> type) Get a new where condition based on business types.
Condition	getConditionChain(List<<any>> attributeChain, Condition condition)
Condition	getConditionLinearChain(BusinessType type, List<BusinessAttribute> attributes, Object value, Condition.OPERATOR operator) Get condition for n level chaining --------------------------------- Example -> Get all the equipment contains Product names matches with word 'server' ---------------------------- Equipment-includesBoM-includesBoMEntry-linksProduct-objectName contains server ** --------------------------------------------------------------------- "filter" = "includesBoM-includesBoMEntry-linksProduct-objectName contains 'server'"
Order	getDefaultOrder() Gets the default order, which currently is objectName.
Order	getOrder(BusinessAttribute field, boolean desc, boolean caseSensitive) Get a new Order based on data attributes.
Order	getOrder(BusinessType type, BusinessRelationAttribute bra, BusinessAttribute field, boolean desc, boolean caseSensitive) Get a new Order based on related attributes.
Order	getOrder(BusinessType type, BusinessRelationAttribute bra, BusinessDataAttribute field, boolean desc, boolean caseSensitive) Get a new Order based on related attributes.
Order	getOrder(List<BusinessType> types, BusinessRelationAttribute bra, BusinessAttribute field, boolean desc, boolean caseSensitive) Get a new Order based on related attributes.
Order	getOrderBusinessType(boolean desc) Get a new Order based on business type URI.
Order	getOrderChain(List<<any>> attributeChain, Order order)
Condition	getSearchAttributesCondition(BusinessType type, BusinessAttribute predicate, Map<String,List<BusinessAttribute>> searchAttributes, Condition.OPERATOR searchOperator, String search)
Condition	getSearchCondition(BusinessType type, List<BusinessAttribute> searchAttributes, Condition.OPERATOR searchOperator, String search) ${tags}

Method Detail

createAggregateCondition

ConditionAggregate createAggregateCondition()

Returns:

createAggregateConditionAND

ConditionAggregate createAggregateConditionAND()

Returns:

createAggregateConditionOR

ConditionAggregate createAggregateConditionOR()

Returns:

getAllBDASearchCondition

Condition getAllBDASearchCondition(Object value)

Parameters:

value -

operator -

Returns:

getCondition

Condition getCondition(BusinessAttribute attribute,
                       Object value,
                       Condition.OPERATOR operator)

Get a new where condition based on a data attribute for user filtering. Example of usage:

• WorkflowItem status = STARTED: getCondition(Schema.workflowItemStatus, "STARTED", OPERATOR.EQUAL)
• WorkflowItem start within last 7 days: Calendar dateOpen = Calendar.getInstance(); dateOpen.add(Calendar.DATE, -7); getCondition(Schema.workflowItemDateOfOpen, dateOpen, OPERATOR.GREATER_THAN_EQUAL)
• Workflow name contains ABC (case insensitive): getCondition(Schema.objectName, "ABC", OPERATOR.CONTAINS)

Parameters:

attribute - The attribute (predicate) for the condition

value - The value to match against

operator - The operator to use, typically is Contains

Returns:

The formed condition.

getCondition

Condition getCondition(BusinessObject primaryBO,
                       Condition.OPERATOR operator)

Get a new where condition based on a business object for user filtering.

Parameters:

primaryBO - The BO filter

operator - The operator to use

Returns:

The formed condition

getCondition

Condition getCondition(BusinessType type)

Get a new where condition based on a business type.

Parameters:

type - The BusinessType

Returns:

The formed condition

getCondition

Condition getCondition(BusinessType type,
                       BusinessRelationAttribute attribute,
                       BusinessAttribute objectField,
                       Object value,
                       Condition.OPERATOR operator)

Get a new where condition based on a related object's business data attribute for user filtering. Example of usage:

• Quotes which belongs to account with name containing ABC: getCondition(Schema.Account, Schema.quoteContainedBy, Schema.objectName, "ABC", OPERATOR.CONTAINS)
• Quotes which belongs to Opportunity with volume less than 1000: getCondition(Schema.Opportunity, Schema.quoteContainedBy, Schema.opportunityVolume, 1000, OPERATOR.LESS_THAN)

Parameters:

type - The businessType that the attribute refers to.

attribute - The relationship.

objectField - The field of the object to filter by.

value - The value to filter by.

operator - The operator to use.

Returns:

The formed condition.

getCondition

Condition getCondition(Collection<BusinessType> type)

Get a new where condition based on business types.

Parameters:

types - The BusinessTypes

Returns:

The formed condition

getConditionChain

Condition getConditionChain(List<<any>> attributeChain,
                            Condition condition)

Parameters:

attributeChain -

condition -

Returns:

The formed condition.

getConditionLinearChain

Condition getConditionLinearChain(BusinessType type,
                                  List<BusinessAttribute> attributes,
                                  Object value,
                                  Condition.OPERATOR operator)

Get condition for n level chaining --------------------------------- Example -> Get all the equipment contains Product names matches with word 'server' ---------------------------- Equipment-includesBoM-includesBoMEntry-linksProduct-objectName contains server ** --------------------------------------------------------------------- "filter" = "includesBoM-includesBoMEntry-linksProduct-objectName contains 'server'"

getDefaultOrder

Order getDefaultOrder()

Gets the default order, which currently is objectName.

Returns:

The default order.

getOrder

Order getOrder(BusinessAttribute field,
               boolean desc,
               boolean caseSensitive)

Get a new Order based on data attributes.

Parameters:

field - The data attribute, e.g. objectName

desc - Whether the ordering is ascending or descending order.

caseSensitive - Whether the ordering should be case-sensitive or not

Returns:

The order based on data attributes

getOrder

Order getOrder(BusinessType type,
               BusinessRelationAttribute bra,
               BusinessAttribute field,
               boolean desc,
               boolean caseSensitive)

Get a new Order based on related attributes.

Parameters:

type - The type linked by the bra. (To be removed)

bra - The relationship attribute, e.g. quoteContainedBy

field - The field to order based on the related attributed, e.g. objectName or label.

desc - Whether the ordering is ascending or descending order.

caseSensitive - Whether the ordering should be case-sensitive or not

Returns:

The order based on the related attribute.

getOrder

Order getOrder(BusinessType type,
               BusinessRelationAttribute bra,
               BusinessDataAttribute field,
               boolean desc,
               boolean caseSensitive)

Get a new Order based on related attributes.

Parameters:

type - The type linked by the bra. (To be removed)

bra - The relationship attribute, e.g. quoteContainedBy

field - The field to order based on the related attributed, e.g. objectName.

desc - Whether the ordering is ascending or descending order.

caseSensitive - Whether the ordering should be case-sensitive or not

Returns:

The order based on the related attribute.

getOrder

Order getOrder(List<BusinessType> types,
               BusinessRelationAttribute bra,
               BusinessAttribute field,
               boolean desc,
               boolean caseSensitive)

Get a new Order based on related attributes.

Parameters:

types - The types linked by the bra. (To be removed)

bra - The relationship attribute, e.g. quoteContainedBy

field - The field to order based on the related attributed, e.g. objectName.

desc - Whether the ordering is ascending or descending order.

caseSensitive - Whether the ordering should be case-sensitive or not

Returns:

The order based on the related attribute.

getOrderBusinessType

Order getOrderBusinessType(boolean desc)

Get a new Order based on business type URI.

Parameters:

desc - Whether the ordering is ascending or descending order

Returns:

The order based on the business type URI.

getOrderChain

Order getOrderChain(List<<any>> attributeChain,
                    Order order)

Parameters:

attributeChain -

order -

Returns:

getSearchAttributesCondition

Condition getSearchAttributesCondition(BusinessType type,
                                       BusinessAttribute predicate,
                                       Map<String,List<BusinessAttribute>> searchAttributes,
                                       Condition.OPERATOR searchOperator,
                                       String search)

getSearchCondition

Condition getSearchCondition(BusinessType type,
                             List<BusinessAttribute> searchAttributes,
                             Condition.OPERATOR searchOperator,
                             String search)

${tags}