org.broadleafcommerce.openadmin.client.dto
Class PersistencePerspective

java.lang.Object
  org.broadleafcommerce.openadmin.client.dto.PersistencePerspective

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, Serializable

public class PersistencePerspective
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable, Serializable

Author:

jfischer

See Also:

Serialized Form

Field Summary

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

Constructor Summary

PersistencePerspective()

PersistencePerspective(OperationTypes operationTypes, String[] additionalNonPersistentProperties, ForeignKey[] additionalNonPersistentForeignKeys)

Method Summary

void	addPersistencePerspectiveItem(PersistencePerspectiveItemType type, PersistencePerspectiveItem item)
ForeignKey[]	getAdditionalForeignKeys()
String[]	getAdditionalNonPersistentProperties()
String	getConfigurationKey()
String[]	getExcludeFields() Deprecated.
String[]	getIncludeFields() Deprecated.
OperationTypes	getOperationTypes()
Map<PersistencePerspectiveItemType,PersistencePerspectiveItem>	getPersistencePerspectiveItems()
Boolean	getPopulateToOneFields() Deprecated.
void	setAdditionalForeignKeys(ForeignKey[] additionalNonPersistentForeignKeys)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

Constructor Detail

PersistencePerspective

public PersistencePerspective()

PersistencePerspective

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

Method Detail

getAdditionalNonPersistentProperties

public String[] getAdditionalNonPersistentProperties()

setAdditionalNonPersistentProperties

public void setAdditionalNonPersistentProperties(String[] additionalNonPersistentProperties)

getAdditionalForeignKeys

public ForeignKey[] getAdditionalForeignKeys()

setAdditionalForeignKeys

public void setAdditionalForeignKeys(ForeignKey[] additionalNonPersistentForeignKeys)

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)