org.broadleafcommerce.openadmin.dto

Class PersistencePerspective

java.lang.Object

org.broadleafcommerce.openadmin.dto.PersistencePerspective

All Implemented Interfaces:

Serializable

public class PersistencePerspective
extends Object
implements Serializable

Author:

jfischer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ForeignKey[]	additionalForeignKeys
protected String[]	additionalNonPersistentProperties
protected String	configurationKey
protected String[]	excludeFields
protected String[]	includeFields
protected OperationTypes	operationTypes
protected Map<PersistencePerspectiveItemType,PersistencePerspectiveItem>	persistencePerspectiveItems
protected Boolean	populateToOneFields
protected Boolean	showArchivedFields
protected Boolean	useServerSideInspectionCache

Constructor Summary

Constructors

Constructor and Description
PersistencePerspective()
PersistencePerspective(OperationTypes operationTypes, String[] additionalNonPersistentProperties, ForeignKey[] additionalForeignKeys)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPersistencePerspectiveItem(PersistencePerspectiveItemType type, PersistencePerspectiveItem item)
PersistencePerspective	clonePersistencePerspective()
boolean	equals(Object o)
ForeignKey[]	getAdditionalForeignKeys()
String[]	getAdditionalNonPersistentProperties()
String	getConfigurationKey()
String[]	getExcludeFields() Deprecated.
String[]	getIncludeFields() Deprecated.
OperationTypes	getOperationTypes()
Map<PersistencePerspectiveItemType,PersistencePerspectiveItem>	getPersistencePerspectiveItems()
Boolean	getPopulateToOneFields() Deprecated.
Boolean	getShowArchivedFields()
Boolean	getUseServerSideInspectionCache()
int	hashCode()
void	setAdditionalForeignKeys(ForeignKey[] additionalForeignKeys)
void	setAdditionalNonPersistentProperties(String[] additionalNonPersistentProperties)
void	setConfigurationKey(String configurationKey)
void	setExcludeFields(String[] excludeManyToOneFields) Deprecated.
void	setIncludeFields(String[] includeManyToOneFields) Deprecated.
void	setOperationTypes(OperationTypes operationTypes)
void	setPersistencePerspectiveItems(Map<PersistencePerspectiveItemType,PersistencePerspectiveItem> persistencePerspectiveItems)
void	setPopulateToOneFields(Boolean populateToOneFields) Deprecated.
void	setShowArchivedFields(Boolean showArchivedFields)
void	setUseServerSideInspectionCache(Boolean useServerSideInspectionCache)

Methods inherited from class java.lang.Object

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

Field Detail

additionalNonPersistentProperties

protected String[] additionalNonPersistentProperties

additionalForeignKeys

protected ForeignKey[] additionalForeignKeys

persistencePerspectiveItems

protected Map<PersistencePerspectiveItemType,PersistencePerspectiveItem> persistencePerspectiveItems

operationTypes

protected OperationTypes operationTypes

populateToOneFields

protected Boolean populateToOneFields

excludeFields

protected String[] excludeFields

includeFields

protected String[] includeFields

configurationKey

protected String configurationKey

showArchivedFields

protected Boolean showArchivedFields

useServerSideInspectionCache

protected Boolean useServerSideInspectionCache

Constructor Detail

PersistencePerspective

public PersistencePerspective()

PersistencePerspective

public PersistencePerspective(OperationTypes operationTypes,
                      String[] additionalNonPersistentProperties,
                      ForeignKey[] additionalForeignKeys)

Method Detail

getAdditionalNonPersistentProperties

public String[] getAdditionalNonPersistentProperties()

setAdditionalNonPersistentProperties

public void setAdditionalNonPersistentProperties(String[] additionalNonPersistentProperties)

getAdditionalForeignKeys

public ForeignKey[] getAdditionalForeignKeys()

setAdditionalForeignKeys

public void setAdditionalForeignKeys(ForeignKey[] additionalForeignKeys)

getOperationTypes

public OperationTypes getOperationTypes()

setOperationTypes

public void setOperationTypes(OperationTypes operationTypes)

addPersistencePerspectiveItem

public void addPersistencePerspectiveItem(PersistencePerspectiveItemType type,
                                 PersistencePerspectiveItem item)

getPersistencePerspectiveItems

public Map<PersistencePerspectiveItemType,PersistencePerspectiveItem> getPersistencePerspectiveItems()

setPersistencePerspectiveItems

public void setPersistencePerspectiveItems(Map<PersistencePerspectiveItemType,PersistencePerspectiveItem> persistencePerspectiveItems)

getPopulateToOneFields

@Deprecated
public Boolean getPopulateToOneFields()

Deprecated.

Retrieves whether or not ManyToOne and OneToOne field boundaries will be traversed when retrieving and populating entity fields. Implementation should use the @AdminPresentationClass annotation instead.

Returns:

Whether or not ManyToOne and OneToOne field boundaries will be crossed.

setPopulateToOneFields

@Deprecated
public void setPopulateToOneFields(Boolean populateToOneFields)

Deprecated.

Sets whether or not ManyToOne and OneToOne field boundaries will be traversed when retrieving and populating entity fields. Implementation should use the @AdminPresentationClass annotation instead.

getExcludeFields

@Deprecated
public String[] getExcludeFields()

Deprecated.

Retrieve the list of fields to exclude from the admin presentation. Implementations should use the excluded property of the AdminPresentation annotation instead, or use an AdminPresentationOverride if re-enabling a Broadleaf field is desired. If multiple datasources point to the same entity, but different exclusion behavior is required, a custom persistence handler may be employed with different inspect method implementations to account for the variations.

Returns:

list of fields to exclude from the admin

setExcludeFields

@Deprecated
public void setExcludeFields(String[] excludeManyToOneFields)

Deprecated.

Set the list of fields to exclude from the admin presentation. Implementations should use the excluded property of the AdminPresentation annotation instead, or use an AdminPresentationOverride if re-enabling a Broadleaf field is desired. If multiple datasources point to the same entity, but different exclusion behavior is required, a custom persistence handler may be employed with different inspect method implementations to account for the variations.

Parameters:

excludeManyToOneFields -

getIncludeFields

@Deprecated
public String[] getIncludeFields()

Deprecated.

Get the list of fields to include in the admin presentation. Implementations should use excludeFields instead.

Returns:

list of fields to include in the admin

setIncludeFields

@Deprecated
public void setIncludeFields(String[] includeManyToOneFields)

Deprecated.

Set the list of fields to include in the admin presentation. Implementations should use excludeFields instead.

Parameters:

includeManyToOneFields -

getConfigurationKey

public String getConfigurationKey()

setConfigurationKey

public void setConfigurationKey(String configurationKey)

getShowArchivedFields

public Boolean getShowArchivedFields()

setShowArchivedFields

public void setShowArchivedFields(Boolean showArchivedFields)

getUseServerSideInspectionCache

public Boolean getUseServerSideInspectionCache()

setUseServerSideInspectionCache

public void setUseServerSideInspectionCache(Boolean useServerSideInspectionCache)

clonePersistencePerspective

public PersistencePerspective clonePersistencePerspective()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object