data
Interface DataBasketCondition

All Superinterfaces:

DataBasketKeys, Serializable

All Known Implementing Classes:

DataBasketConditionImpl

public interface DataBasketCondition

extends DataBasketKeys, Serializable

Condition used for filtering DataBaskets.

Since:

v2.0

Author:

Steffen Zschaler

Field Summary

Fields inherited from interface data.DataBasketKeys

CATALOG_ITEM_MAIN_KEY, STOCK_ITEM_MAIN_KEY

Method Summary

DataBasketEntryDestination	getDestination() Return the destination for operations that match the condition.
String	getMainKey() Return the main key that DataBasketEntries must have to match the condition.
String	getSecondaryKey() Return the secondary key that DataBasketEntries must have to match the condition.
DataBasketEntrySource	getSource() Return the source for operations that match the condition.
Object	getValue() Return the object for operations that match the condition.
boolean	match(DataBasketEntry dbe) Return true for DataBasketEntries that match the condition.

Method Detail

getMainKey

public String getMainKey()

Return the main key that DataBasketEntries must have to match the condition. Returning null means any main key.

Override:

Always

getSecondaryKey

public String getSecondaryKey()

Return the secondary key that DataBasketEntries must have to match the condition. Returning null means any secondary key.

Override:

Always

getSource

public DataBasketEntrySource getSource()

Return the source for operations that match the condition. Returning null means any source, other values mean exactly what they say, i.e. they are tested for identity.

Override:

Always

getDestination

public DataBasketEntryDestination getDestination()

Return the destination for operations that match the condition. Returning null means any destination, other values mean exactly what they say, i.e. they are tested for identity.

Override:

Always

getValue

public Object getValue()

Return the object for operations that match the condition. Returning null means check each DataBasketEntry by calling match(), other values mean exactly what they say, i.e. they are tested for identity.

Override:

Always

match

public boolean match(DataBasketEntry dbe)

Return true for DataBasketEntries that match the condition. This method is only called for DataBasketEntries that have already been filtered by their main and secondary key, as well as their source and destination. Additionally, it is only called if getValue() returns null.

Override:

Always