org.broadleafcommerce.common.presentation

Annotation Type AdminPresentationOperationTypes

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

Annotation for defining how CRUD operations are performed on an advanced collection in Broadleaf Commerce. This is an advanced configuration, as the default operation settings are appropriate in most cases.

Author:

Jeff Fischer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
OperationType	addType How should the system execute an addition for this item
OperationType	fetchType How should the system execute a fetch
OperationType	inspectType OperationType values are generally ignored for inspect and should be defined as BASIC for consistency in most circumstances.
OperationType	removeType How should the system execute a removal of this item.
OperationType	updateType How should the system execute an update for this item

Element Detail

addType

public abstract OperationType addType

How should the system execute an addition for this item

OperationType BASIC will result in the item being inserted
OperationType ADORNEDTARGETLIST will result in a adorned target entity being added (not either of the associated entities).
CrossSaleProductImpl is an example of an adorned target entity, since it adds additional fields around the target Product entity.
OperationType MAP will result in the item being added to the requisite map in the containing entity.

Returns:

the type of the add operation

Default:

org.broadleafcommerce.common.presentation.client.OperationType.BASIC

updateType

public abstract OperationType updateType

How should the system execute an update for this item

OperationType BASIC will result in the item being updated based on it's primary key
OperationType ADORNEDTARGETLIST will result in a join structure entity being updated (not either of the associated entities).
CrossSaleProductImpl is an example of an adorned target entity, since it adds additional fields around the target Product entity.
OperationType MAP will result in the item being updated to the requisite map in the containing entity.

Returns:

the type of the update operation

Default:

org.broadleafcommerce.common.presentation.client.OperationType.BASIC

removeType

public abstract OperationType removeType

How should the system execute a removal of this item.

OperationType BASIC will result in the item being removed based on its primary key
OperationType NONDESTRUCTIVEREMOVE will result in the item being removed from the containing list in the containing entity. This is useful when you don't want the item to actually be deleted, but simply removed from the parent collection.
OperationType ADORNEDTARGETLIST will result in a join structure being deleted (not either of the associated entities).
CrossSaleProductImpl is an example of an adorned target entity, since it adds additional fields around the target Product entity.
OperationType MAP will result in the item being removed from the requisite map in the containing entity.

Returns:

the type of remove operation

Default:

org.broadleafcommerce.common.presentation.client.OperationType.BASIC

fetchType

public abstract OperationType fetchType

How should the system execute a fetch

OperationType BASIC will result in a search for items having one or more basic properties matches
OperationType ADORNEDTARGETLIST will result in search for target items that match the parent association in the adorned target entity.
CrossSaleProductImpl is an example of an adorned target entity, since it adds additional fields around the target Product entity.
OperationType MAP will result retrieval of all map entries for the requisite map in the containing entity.

Returns:

the type of the fetch operation

Default:

org.broadleafcommerce.common.presentation.client.OperationType.BASIC

inspectType

public abstract OperationType inspectType

OperationType values are generally ignored for inspect and should be defined as BASIC for consistency in most circumstances. This API is meant to support future persistence modules where specialized inspect phase management may be required.

Returns:

the type of the inspect operation

Default:

org.broadleafcommerce.common.presentation.client.OperationType.BASIC