com.openpojo.business.annotation

Annotation Type BusinessKey

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface BusinessKey

This annotation is used to indicate a field is part of the business identity. Fields tagged with BusinessKey annotation will be part of the equals / hashcode. Key fields are:
1. caseSensitive (default is true)
2. required (default is true)
3. composite (default is false)

caseSensitive usage:
If a field tagged with caseSensitive=false (i.e. not case sensitive) AND the field is of type Character or CharacterSequence, the field must be normalized and then hashcode/equality is performed.

Example: BusinessKey(caseSensitive = false) String one = "hello world"
must have the same hashcode & equality as:
one = "HELLO WORLD"
required usage:
If a field is tagged with required = false, then the field will only be used in equality only if its populated. Two null fields tagged with required = false are equal.

composite usage:
If a field is tagged with composite = true, then two things happen, first, required configuration is ignored, and this field is treated as optional part of a group. This also means that one of the fields tagged with composite MUST have a value.
Example: If you had a POJO called Person, that had a FirstName & LastName fields, and you want to set a rule that is for this POJO to be complete, one of the names MUST be populated, but its not important which one.
This is typical composite key usage.

Author:

oshoukry

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	caseSensitive Set to true if the field is of type Character or CharSequence to ignore case when comparing.
boolean	composite Set to true if this key is part of a group where any one of the group needs to be not null.
boolean	required Set to True to indicate field required to be populated.

Element Detail

caseSensitive

public abstract boolean caseSensitive

Set to true if the field is of type Character or CharSequence to ignore case when comparing.

Returns:

returns the value for caseSensitive; defaults to true.

Default:

true

required

public abstract boolean required

Set to True to indicate field required to be populated.

Returns:

returns true if the field is required for business identity validation, defaults to true.

Default:

true

composite

public abstract boolean composite

Set to true if this key is part of a group where any one of the group needs to be not null. Setting Composite to true, shadows the "required" above, since composite is OR-ing against any that are populated. With at least one of the composite group being non-null.

Returns:

returns weather this key is part of a group, defaults to false;

Default:

false