org.broadleafcommerce.openadmin.dto

Class OperationTypes

java.lang.Object

org.broadleafcommerce.openadmin.dto.OperationTypes

All Implemented Interfaces:

Serializable

public class OperationTypes
extends Object
implements Serializable

Author:

jfischer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OperationTypes()
OperationTypes(OperationType fetchType, OperationType removeType, OperationType addType, OperationType updateType, OperationType inspectType)

Method Summary

Methods

Modifier and Type	Method and Description
OperationTypes	cloneOperationTypes()
boolean	equals(Object o)
OperationType	getAddType() How should the system execute an addition for this item OperationType BASIC will result in the item being inserted OperationType NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC.
OperationType	getFetchType() How should the system execute a fetch OperationType BASIC will result in a search for items having one or more basic properties matches OperationType FOREINKEY is not support and will result in the same behavior as BASIC.
OperationType	getInspectType() OperationType values are generally ignored for inspect and should be defined as BASIC for consistency in most circumstances.
OperationType	getRemoveType() How should the system execute a removal of this item.
OperationType	getUpdateType() 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 NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC.
int	hashCode()
void	setAddType(OperationType addType) How should the system execute an addition for this item OperationType BASIC will result in the item being inserted OperationType NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC.
void	setFetchType(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 FOREINKEY is not support and will result in the same behavior as BASIC.
void	setInspectType(OperationType inspectType) OperationType values are generally ignored for inspect and should be defined as BASIC for consistency in most circumstances.
void	setRemoveType(OperationType removeType) How should the system execute a removal of this item.
void	setUpdateType(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 NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OperationTypes

public OperationTypes()

OperationTypes

public OperationTypes(OperationType fetchType,
              OperationType removeType,
              OperationType addType,
              OperationType updateType,
              OperationType inspectType)

Method Detail

getRemoveType

public OperationType getRemoveType()

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). org.broadleafcommerce.core.catalog.domain.CategoryProductXrefImpl is an example of a join structure entity. OperationType MAP will result in the item being removed from the requisite map in the containing entity.

Returns:

the type of remove operation

setRemoveType

public void setRemoveType(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 be removed 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). org.broadleafcommerce.core.catalog.domain.CategoryProductXrefImpl is an example of a join structure entity. OperationType MAP will result in the item being removed from the requisite map in the containing entity.

Parameters:

removeType -

getAddType

public OperationType getAddType()

How should the system execute an addition for this item

OperationType BASIC will result in the item being inserted OperationType NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC. Note, any foreign key associations in the persistence perspective (@see PersistencePerspective) will be honored during the BASIC based add. OperationType ADORNEDTARGETLIST will result in a join structure entity being added (not either of the associated entities). org.broadleafcommerce.core.catalog.domain.CategoryProductXrefImpl is an example of a join structure 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

setAddType

public void setAddType(OperationType addType)

How should the system execute an addition for this item

OperationType BASIC will result in the item being inserted OperationType NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC. Note, any foreign key associations in the persistence perspective (@see PersistencePerspective) will be honored during the BASIC based add. OperationType ADORNEDTARGETLIST will result in a join structure entity being added (not either of the associated entities). org.broadleafcommerce.core.catalog.domain.CategoryProductXrefImpl is an example of a join structure entity. OperationType MAP will result in the item being added to the requisite map in the containing entity.

Parameters:

addType -

getUpdateType

public OperationType getUpdateType()

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 NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC. Note, any foreign key associations in the persistence perspective (@see PersistencePerspective) will be honored during the BASIC based update. OperationType ADORNEDTARGETLIST will result in a join structure entity being updated (not either of the associated entities). org.broadleafcommerce.core.catalog.domain.CategoryProductXrefImpl is an example of a join structure 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

setUpdateType

public void setUpdateType(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 NONDESTRUCTIVEREMOVE is not supported and will result in the same behavior as BASIC. Note, any foreign key associations in the persistence perspective (@see PersistencePerspective) will be honored during the BASIC based update. OperationType ADORNEDTARGETLIST will result in a join structure entity being updated (not either of the associated entities). org.broadleafcommerce.core.catalog.domain.CategoryProductXrefImpl is an example of a join structure entity. OperationType MAP will result in the item being updated to the requisite map in the containing entity.

Parameters:

updateType -

getFetchType

public OperationType getFetchType()

How should the system execute a fetch

OperationType BASIC will result in a search for items having one or more basic properties matches OperationType FOREINKEY is not support and will result in the same behavior as BASIC. Note, any foreign key associations will be included as part of the query. OperationType ADORNEDTARGETLIST will result in search for items that match one of the associations in a join structure. For example, CategoryProductXrefImpl is used in a AdornedTargetList fetch to retrieve all products for a particular category. OperationType MAP will result retrieval of all map entries for the requisite map in the containing entity.

Returns:

the type of the fetch operation

setFetchType

public void setFetchType(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 FOREINKEY is not support and will result in the same behavior as BASIC. Note, any foreign key associations will be included as part of the query. OperationType ADORNEDTARGETLIST will result in search for items that match one of the associations in a join structure. For example, CategoryProductXrefImpl is used in a AdornedTargetList fetch to retrieve all products for a particular category. OperationType MAP will result retrieval of all map entries for the requisite map in the containing entity.

Parameters:

fetchType -

getInspectType

public OperationType getInspectType()

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

setInspectType

public void setInspectType(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.

Parameters:

inspectType -

cloneOperationTypes

public OperationTypes cloneOperationTypes()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object