org.broadleafcommerce.openadmin.server.domain

Class PersistencePackageRequest

java.lang.Object

org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest

public class PersistencePackageRequest
extends Object

A DTO class used to seed a persistence package.

Author:

Andre Azzolini (apazzolini)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistencePackageRequest.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ForeignKey>	additionalForeignKeys
protected AdornedTargetList	adornedList
protected String	ceilingEntityClassname
protected String	configKey
protected List<String>	customCriteria
protected Entity	entity
protected List<FilterAndSortCriteria>	filterAndSortCriteria
protected ForeignKey	foreignKey
protected MapStructure	mapStructure
protected Integer	maxIndex
protected String	msg
protected OperationTypes	operationTypesOverride
protected String	requestingEntityName
protected SectionCrumb[]	sectionCrumbs
protected String	sectionEntityField
protected Integer	startIndex
protected Map<String,PersistencePackageRequest>	subRequests
protected PersistencePackageRequest.Type	type
protected boolean	validateUnsubmittedProperties

Constructor Summary

Constructors

Constructor and Description
PersistencePackageRequest()
PersistencePackageRequest(PersistencePackageRequest.Type type)

Method Summary

Methods

Modifier and Type	Method and Description
PersistencePackageRequest	addAdditionalForeignKey(ForeignKey foreignKey)
PersistencePackageRequest	addCustomCriteria(String customCriteria)
PersistencePackageRequest	addFilterAndSortCriteria(FilterAndSortCriteria filterAndSortCriteria)
PersistencePackageRequest	addFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)
PersistencePackageRequest	addFilterAndSortCriteria(List<FilterAndSortCriteria> filterAndSortCriteria)
PersistencePackageRequest	addSubRequest(String infoPropertyName, PersistencePackageRequest subRequest)
static PersistencePackageRequest	adorned()
static PersistencePackageRequest	fromMetadata(FieldMetadata md, List<SectionCrumb> sectionCrumbs) Creates a semi-populate PersistencePacakageRequest based on the specified FieldMetadata.
ForeignKey[]	getAdditionalForeignKeys()
AdornedTargetList	getAdornedList()
String	getCeilingEntityClassname()
String	getConfigKey()
String[]	getCustomCriteria()
Entity	getEntity()
FilterAndSortCriteria[]	getFilterAndSortCriteria()
ForeignKey	getForeignKey()
MapStructure	getMapStructure()
Integer	getMaxIndex()
String	getMsg()
OperationTypes	getOperationTypesOverride()
String	getRequestingEntityName()
SectionCrumb[]	getSectionCrumbs()
String	getSectionEntityField()
Integer	getStartIndex()
Map<String,PersistencePackageRequest>	getSubRequests()
PersistencePackageRequest.Type	getType()
boolean	isValidateUnsubmittedProperties()
static PersistencePackageRequest	map()
PersistencePackageRequest	removeFilterAndSortCriteria(String name)
void	setAdditionalForeignKeys(ForeignKey[] additionalForeignKeys)
void	setAdornedList(AdornedTargetList adornedList)
void	setCeilingEntityClassname(String ceilingEntityClassname)
void	setConfigKey(String configKey)
void	setCustomCriteria(String[] customCriteria)
void	setEntity(Entity entity)
void	setFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)
void	setForeignKey(ForeignKey foreignKey)
void	setMapStructure(MapStructure mapStructure)
void	setMaxIndex(Integer maxIndex)
void	setMsg(String msg)
void	setOperationTypesOverride(OperationTypes operationTypesOverride)
void	setRequestingEntityName(String requestingEntityName)
void	setSectionCrumbs(SectionCrumb[] sectionCrumbs)
void	setSectionEntityField(String sectionEntityField)
void	setStartIndex(Integer startIndex)
void	setSubRequests(Map<String,PersistencePackageRequest> subRequests)
void	setType(PersistencePackageRequest.Type type)
void	setValidateUnsubmittedProperties(boolean validateUnsubmittedProperties)
static PersistencePackageRequest	standard()
PersistencePackageRequest	withAdornedList(AdornedTargetList adornedList)
PersistencePackageRequest	withCeilingEntityClassname(String className)
PersistencePackageRequest	withConfigKey(String configKey)
PersistencePackageRequest	withCustomCriteria(String[] customCriteria)
PersistencePackageRequest	withEntity(Entity entity)
PersistencePackageRequest	withFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)
PersistencePackageRequest	withForeignKey(ForeignKey foreignKey)
PersistencePackageRequest	withMapStructure(MapStructure mapStructure)
PersistencePackageRequest	withMaxIndex(Integer maxIndex)
PersistencePackageRequest	withMsg(String msg)
PersistencePackageRequest	withRequestingEntityName(String requestingEntityName)
PersistencePackageRequest	withSectionCrumbs(List<SectionCrumb> sectionCrumbs)
PersistencePackageRequest	withSectionEntityField(String sectionEntityField)
PersistencePackageRequest	withStartIndex(Integer startIndex)
PersistencePackageRequest	withType(PersistencePackageRequest.Type type)

Methods inherited from class java.lang.Object

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

Field Detail

type

protected PersistencePackageRequest.Type type

ceilingEntityClassname

protected String ceilingEntityClassname

configKey

protected String configKey

adornedList

protected AdornedTargetList adornedList

mapStructure

protected MapStructure mapStructure

entity

protected Entity entity

foreignKey

protected ForeignKey foreignKey

startIndex

protected Integer startIndex

maxIndex

protected Integer maxIndex

sectionCrumbs

protected SectionCrumb[] sectionCrumbs

sectionEntityField

protected String sectionEntityField

requestingEntityName

protected String requestingEntityName

msg

protected String msg

subRequests

protected Map<String,PersistencePackageRequest> subRequests

validateUnsubmittedProperties

protected boolean validateUnsubmittedProperties

operationTypesOverride

protected OperationTypes operationTypesOverride

additionalForeignKeys

protected List<ForeignKey> additionalForeignKeys

customCriteria

protected List<String> customCriteria

filterAndSortCriteria

protected List<FilterAndSortCriteria> filterAndSortCriteria

Constructor Detail

PersistencePackageRequest

public PersistencePackageRequest()

PersistencePackageRequest

public PersistencePackageRequest(PersistencePackageRequest.Type type)

Method Detail

standard

public static PersistencePackageRequest standard()

adorned

public static PersistencePackageRequest adorned()

map

public static PersistencePackageRequest map()

fromMetadata

public static PersistencePackageRequest fromMetadata(FieldMetadata md,
                                     List<SectionCrumb> sectionCrumbs)

Creates a semi-populate PersistencePacakageRequest based on the specified FieldMetadata. This initializer will copy over persistence perspective items from the metadata as well as set the appropriate OperationTypes as specified in the annotation/xml configuration for the field.

Parameters:

md -

Returns:

the newly created PersistencePackageRequest

withType

public PersistencePackageRequest withType(PersistencePackageRequest.Type type)

withCeilingEntityClassname

public PersistencePackageRequest withCeilingEntityClassname(String className)

withForeignKey

public PersistencePackageRequest withForeignKey(ForeignKey foreignKey)

withConfigKey

public PersistencePackageRequest withConfigKey(String configKey)

withFilterAndSortCriteria

public PersistencePackageRequest withFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)

withAdornedList

public PersistencePackageRequest withAdornedList(AdornedTargetList adornedList)

withMapStructure

public PersistencePackageRequest withMapStructure(MapStructure mapStructure)

withCustomCriteria

public PersistencePackageRequest withCustomCriteria(String[] customCriteria)

withEntity

public PersistencePackageRequest withEntity(Entity entity)

withStartIndex

public PersistencePackageRequest withStartIndex(Integer startIndex)

withMaxIndex

public PersistencePackageRequest withMaxIndex(Integer maxIndex)

withSectionCrumbs

public PersistencePackageRequest withSectionCrumbs(List<SectionCrumb> sectionCrumbs)

withSectionEntityField

public PersistencePackageRequest withSectionEntityField(String sectionEntityField)

withRequestingEntityName

public PersistencePackageRequest withRequestingEntityName(String requestingEntityName)

withMsg

public PersistencePackageRequest withMsg(String msg)

addAdditionalForeignKey

public PersistencePackageRequest addAdditionalForeignKey(ForeignKey foreignKey)

addSubRequest

public PersistencePackageRequest addSubRequest(String infoPropertyName,
                                      PersistencePackageRequest subRequest)

addCustomCriteria

public PersistencePackageRequest addCustomCriteria(String customCriteria)

addFilterAndSortCriteria

public PersistencePackageRequest addFilterAndSortCriteria(FilterAndSortCriteria filterAndSortCriteria)

addFilterAndSortCriteria

public PersistencePackageRequest addFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)

addFilterAndSortCriteria

public PersistencePackageRequest addFilterAndSortCriteria(List<FilterAndSortCriteria> filterAndSortCriteria)

removeFilterAndSortCriteria

public PersistencePackageRequest removeFilterAndSortCriteria(String name)

getCustomCriteria

public String[] getCustomCriteria()

getAdditionalForeignKeys

public ForeignKey[] getAdditionalForeignKeys()

setAdditionalForeignKeys

public void setAdditionalForeignKeys(ForeignKey[] additionalForeignKeys)

setCustomCriteria

public void setCustomCriteria(String[] customCriteria)

getFilterAndSortCriteria

public FilterAndSortCriteria[] getFilterAndSortCriteria()

setFilterAndSortCriteria

public void setFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)

getForeignKey

public ForeignKey getForeignKey()

setForeignKey

public void setForeignKey(ForeignKey foreignKey)

getType

public PersistencePackageRequest.Type getType()

setType

public void setType(PersistencePackageRequest.Type type)

getCeilingEntityClassname

public String getCeilingEntityClassname()

setCeilingEntityClassname

public void setCeilingEntityClassname(String ceilingEntityClassname)

getConfigKey

public String getConfigKey()

setConfigKey

public void setConfigKey(String configKey)

getAdornedList

public AdornedTargetList getAdornedList()

setAdornedList

public void setAdornedList(AdornedTargetList adornedList)

getMapStructure

public MapStructure getMapStructure()

setMapStructure

public void setMapStructure(MapStructure mapStructure)

getEntity

public Entity getEntity()

setEntity

public void setEntity(Entity entity)

getOperationTypesOverride

public OperationTypes getOperationTypesOverride()

setOperationTypesOverride

public void setOperationTypesOverride(OperationTypes operationTypesOverride)

getStartIndex

public Integer getStartIndex()

setStartIndex

public void setStartIndex(Integer startIndex)

getMaxIndex

public Integer getMaxIndex()

setMaxIndex

public void setMaxIndex(Integer maxIndex)

getSectionCrumbs

public SectionCrumb[] getSectionCrumbs()

setSectionCrumbs

public void setSectionCrumbs(SectionCrumb[] sectionCrumbs)

getSectionEntityField

public String getSectionEntityField()

setSectionEntityField

public void setSectionEntityField(String sectionEntityField)

getRequestingEntityName

public String getRequestingEntityName()

setRequestingEntityName

public void setRequestingEntityName(String requestingEntityName)

getMsg

public String getMsg()

setMsg

public void setMsg(String msg)

getSubRequests

public Map<String,PersistencePackageRequest> getSubRequests()

setSubRequests

public void setSubRequests(Map<String,PersistencePackageRequest> subRequests)

isValidateUnsubmittedProperties

public boolean isValidateUnsubmittedProperties()

setValidateUnsubmittedProperties

public void setValidateUnsubmittedProperties(boolean validateUnsubmittedProperties)