com.sapportals.wcm.service.relation

Interface IRelationOperandQuery

All Known Subinterfaces:

IRelationPropertyQuery

public interface IRelationOperandQuery

A query term used for a IRelationQueryOperand .

Method Summary

IRelationQuery	between(String lowerValue, String upperValue) Return an expression which selects only those between the given values, such as lowerValue <= x <= upperValue.
IRelationQuery	betweenIgnoreCase(String lowerValue, String upperValue) case insensitive version of between(String, String).
IRelationQuery	equal(String value) Return an expression which selects only those operands matching the given string.
IRelationQuery	equalIgnoreCase(String value) case insensitive version of equal(String).
IRelationQuery	greater(String value) Return an expression which selects only those operands being alphabetically after the given string.
IRelationQuery	greaterEqual(String value) Return an expression which selects only those operands being alphabetically after the given string or matching it.
IRelationQuery	greaterEqualIgnoreCase(String value) case insensitive version of greaterEqual(String).
IRelationQuery	greaterIgnoreCase(String value) case insensitive version of greater(String).
IRelationQuery	inRelationPropertySelection(IPropertyName name, IRelationQuery query) Return an expression which selects only those which match one of the given queries property values (subselect on the given property).
IRelationQuery	inSourceSelection(IRelationQuery query) Return an expression which selects only those which match one of the given queries source operand's id (subselect on source id).
IRelationQuery	inTargetSelection(IRelationQuery query) Return an expression which selects only those which match one of the given queries target operand's id (subselect on target id).
IRelationQuery	less(String value) Return an expression which selects only those operands being alphabetically before the given string.
IRelationQuery	lessEqual(String value) Return an expression which selects only those operands being alphabetically before the given string or matching it.
IRelationQuery	lessEqualIgnoreCase(String value) case insensitive version of lessEqual(String).
IRelationQuery	lessIgnoreCase(String value) case insensitive version of less(String).
IRelationQuery	like(String value) Return an expression which selects only those operands being 'like' the given string.
IRelationQuery	likeIgnoreCase(String value) case insensitive version of like(String).

Method Detail

equal

public IRelationQuery equal(String value)

Return an expression which selects only those operands matching the given string.

Parameters:

value - the String to compare this term with.

Returns:

the IRelationQuery .

equalIgnoreCase

public IRelationQuery equalIgnoreCase(String value)

case insensitive version of equal(String).

Parameters:

value - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

less

public IRelationQuery less(String value)

Return an expression which selects only those operands being alphabetically before the given string.

Parameters:

value - the String to compare this term with.

Returns:

the IRelationQuery .

lessIgnoreCase

public IRelationQuery lessIgnoreCase(String value)

case insensitive version of less(String).

Parameters:

value - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

lessEqual

public IRelationQuery lessEqual(String value)

Return an expression which selects only those operands being alphabetically before the given string or matching it.

Parameters:

value - the String to compare this term with.

Returns:

the IRelationQuery .

lessEqualIgnoreCase

public IRelationQuery lessEqualIgnoreCase(String value)

case insensitive version of lessEqual(String).

Parameters:

value - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

greater

public IRelationQuery greater(String value)

Return an expression which selects only those operands being alphabetically after the given string.

Parameters:

value - the String to compare this term with.

Returns:

the IRelationQuery .

greaterIgnoreCase

public IRelationQuery greaterIgnoreCase(String value)

case insensitive version of greater(String).

Parameters:

value - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

greaterEqual

public IRelationQuery greaterEqual(String value)

Return an expression which selects only those operands being alphabetically after the given string or matching it.

Parameters:

value - the String to compare this term with.

Returns:

the IRelationQuery .

greaterEqualIgnoreCase

public IRelationQuery greaterEqualIgnoreCase(String value)

case insensitive version of greaterEqual(String).

Parameters:

value - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

like

public IRelationQuery like(String value)

Return an expression which selects only those operands being 'like' the given string. In this string the regular SQL-wildcards (like '%' for any string) are used, while '\' is used as the escape character.

Parameters:

value - the String to compare this term with.

Returns:

the IRelationQuery .

likeIgnoreCase

public IRelationQuery likeIgnoreCase(String value)

case insensitive version of like(String).

Parameters:

value - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

between

public IRelationQuery between(String lowerValue,
                              String upperValue)

Return an expression which selects only those between the given values, such as lowerValue <= x <= upperValue.

Parameters:

lowerValue - a String the values have to be greater or equal to.

upperValue - a String the values have to be less or equal to.

Returns:

the IRelationQuery .

betweenIgnoreCase

public IRelationQuery betweenIgnoreCase(String lowerValue,
                                        String upperValue)

case insensitive version of between(String, String).

Parameters:

lowerValue - TBD: Description of the incoming method parameter

upperValue - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

inSourceSelection

public IRelationQuery inSourceSelection(IRelationQuery query)
                                 throws RelationQueryException

Return an expression which selects only those which match one of the given queries source operand's id (subselect on source id).

Parameters:

query - the IRelationQuery to use for the subselect.

Returns:

the IRelationQuery .

Throws:

RelationQueryException - Exception raised in failure situation

RelationQueryException - if the given subquery is not understood by this query's builder.

inTargetSelection

public IRelationQuery inTargetSelection(IRelationQuery query)
                                 throws RelationQueryException

Return an expression which selects only those which match one of the given queries target operand's id (subselect on target id).

Parameters:

query - the IRelationQuery to use for the subselect.

Returns:

the IRelationQuery .

Throws:

RelationQueryException - Exception raised in failure situation

RelationQueryException - if the given subquery is not understood by this query's builder.

inRelationPropertySelection

public IRelationQuery inRelationPropertySelection(IPropertyName name,
                                                  IRelationQuery query)
                                           throws RelationQueryException

Return an expression which selects only those which match one of the given queries property values (subselect on the given property).

Parameters:

name - the IPropertyName of the property to use.

query - the IRelationQuery to use for the subselect.

Returns:

the IRelationQuery .

Throws:

RelationQueryException - Exception raised in failure situation

RelationQueryException - if the given subquery is not understood by this query's builder.