org.broadleafcommerce.common.presentation.override

Annotation Type AdminPresentationMergeEntry

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface AdminPresentationMergeEntry

Represents a override value for a specific admin presentation property.

Author:

Jeff Fischer

See Also:

AdminPresentation, AdminPresentationToOneLookup, AdminPresentationDataDrivenEnumeration, AdminPresentationCollection, AdminPresentationAdornedTargetCollection, AdminPresentationMap

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	propertyType The type for this property override.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean[]	booleanArrayOverrideValue Convenience property for specifying a boolean array value override.
boolean	booleanOverrideValue Convenience property for specifying a boolean value override.
double[]	doubleArrayOverrideValue Convenience property for specifying a double array value override.
double	doubleOverrideValue Convenience property for specifying a double value override.
float[]	floatArrayOverrideValue Convenience property for specifying a float array value override.
float	floatOverrideValue Convenience property for specifying a float value override.
int[]	intArrayOverrideValue Convenience property for specifying a int array value override.
int	intOverrideValue Convenience property for specifying a int value override.
AdminPresentationMapKey[]	keys Property for overriding the map key configuration for a field annotated with the AdminPresentationMap annotation.
long[]	longArrayOverrideValue Convenience property for specifying a long array value override.
long	longOverrideValue Convenience property for specifying a long value override.
AdminPresentationOperationTypes	operationTypes Property for overriding the operationTypes for an advanced collection.
OptionFilterParam[]	optionFilterParams Property for overriding the filter configuration for a field annotated with the AdminPresentationDataDrivenEnumeration annotation.
String	overrideValue The string representation of the override value.
FieldValueConfiguration[]	showIfFieldEquals Property for overriding the showIfFieldEquals annotation for a given field.
String[]	stringArrayOverrideValue Convenience property for specifying a string array value override.
ValidationConfiguration[]	validationConfigurations Property for overriding the validation configuration for a field annotated with the AdminPresentation annotation.

Element Detail

propertyType

public abstract String propertyType

The type for this property override. The types available are specific to the properties available in the various admin presentation annotations. See PropertyType for a comprehensive list of available values organized by admin presentation annotation type.

Returns:

the property override type

See Also:

PropertyType

overrideValue

public abstract String overrideValue

The string representation of the override value. Any primitive property can be specified as a string (int, boolean, enum). The backend override system will be responsible for converting the string representation back to the appropriate type for use by the admin. The type specific override value properties are provided for convenience (e.g. doubleOverrideValue()).

Returns:

The string representation of the property value

Default:

""

doubleOverrideValue

public abstract double doubleOverrideValue

Convenience property for specifying a double value override. The target property must be of this type. This type can also be specified using overrideValue() and the backend will convert.

Returns:

the property override value in the form of a double

Default:

4.9E-324

floatOverrideValue

public abstract float floatOverrideValue

Convenience property for specifying a float value override. The target property must be of this type. This type can also be specified using overrideValue() and the backend will convert.

Returns:

the property override value in the form of a float

Default:

1.401298464324817E-45f

booleanOverrideValue

public abstract boolean booleanOverrideValue

Convenience property for specifying a boolean value override. The target property must be of this type. This type can also be specified using overrideValue() and the backend will convert.

Returns:

the property override value in the form of a boolean

Default:

false

intOverrideValue

public abstract int intOverrideValue

Convenience property for specifying a int value override. The target property must be of this type. This type can also be specified using overrideValue() and the backend will convert.

Returns:

the property override value in the form of a int

Default:

-2147483648

longOverrideValue

public abstract long longOverrideValue

Convenience property for specifying a long value override. The target property must be of this type. This type can also be specified using overrideValue() and the backend will convert.

Returns:

the property override value in the form of a long

Default:

-9223372036854775808L

stringArrayOverrideValue

public abstract String[] stringArrayOverrideValue

Convenience property for specifying a string array value override. The target property must be of this type.

Returns:

the property override value in the form of a string array

Default:

{}

doubleArrayOverrideValue

public abstract double[] doubleArrayOverrideValue

Convenience property for specifying a double array value override. The target property must be of this type.

Returns:

the property override value in the form of a double array

Default:

{}

floatArrayOverrideValue

public abstract float[] floatArrayOverrideValue

Convenience property for specifying a float array value override. The target property must be of this type.

Returns:

the property override value in the form of a float array

Default:

{}

booleanArrayOverrideValue

public abstract boolean[] booleanArrayOverrideValue

Convenience property for specifying a boolean array value override. The target property must be of this type.

Returns:

the property override value in the form of a boolean array

Default:

{}

intArrayOverrideValue

public abstract int[] intArrayOverrideValue

Convenience property for specifying a int array value override. The target property must be of this type.

Returns:

the property override value in the form of a int array

Default:

{}

longArrayOverrideValue

public abstract long[] longArrayOverrideValue

Convenience property for specifying a long array value override. The target property must be of this type.

Returns:

the property override value in the form of a long array

Default:

{}

validationConfigurations

public abstract ValidationConfiguration[] validationConfigurations

Property for overriding the validation configuration for a field annotated with the AdminPresentation annotation.

Returns:

the validation config override

Default:

{}

operationTypes

public abstract AdminPresentationOperationTypes operationTypes

Property for overriding the operationTypes for an advanced collection. See AdminPresentationCollection, AdminPresentationAdornedTargetCollection and AdminPresentationMap for default values for each type.

Returns:

the operationType override

Default:

@org.broadleafcommerce.common.presentation.AdminPresentationOperationTypes(addType=org.broadleafcommerce.common.presentation.client.OperationType.BASIC, fetchType=org.broadleafcommerce.common.presentation.client.OperationType.BASIC, inspectType=org.broadleafcommerce.common.presentation.client.OperationType.BASIC, removeType=org.broadleafcommerce.common.presentation.client.OperationType.BASIC, updateType=org.broadleafcommerce.common.presentation.client.OperationType.BASIC)

optionFilterParams

public abstract OptionFilterParam[] optionFilterParams

Property for overriding the filter configuration for a field annotated with the AdminPresentationDataDrivenEnumeration annotation.

Returns:

the option filter configuration

Default:

{}

keys

public abstract AdminPresentationMapKey[] keys

Property for overriding the map key configuration for a field annotated with the AdminPresentationMap annotation.

Returns:

the map key configuration

Default:

{}

showIfFieldEquals

public abstract FieldValueConfiguration[] showIfFieldEquals

Property for overriding the showIfFieldEquals annotation for a given field. FieldValueConfiguration

Returns:

the field value configurations

Default:

{}