Package 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	Description
static enum	PersistencePackageRequest.Type

Field Summary

Fields

Modifier and Type	Field	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 Long	firstId
protected Long	folderId
protected ForeignKey	foreignKey
protected boolean	isAddOperationInspect
protected boolean	isFolderedLookup
protected boolean	isTreeCollection
protected boolean	isUpdateLookupType
protected Long	lastId
protected Integer	lowerCount
protected MapStructure	mapStructure
protected Integer	maxIndex
protected Integer	maxResults
protected String	msg
protected OperationTypes	operationTypesOverride
protected Integer	pageSize
protected Boolean	presentationFetch
protected String	requestingEntityName
protected SectionCrumb[]	sectionCrumbs
protected String	sectionEntityField
protected String	securityCeilingEntityClassname
protected Integer	startIndex
protected Map<String,PersistencePackageRequest>	subRequests
protected PersistencePackageRequest.Type	type
protected Integer	upperCount
protected boolean	validateUnsubmittedProperties

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PersistencePackageRequest	addAdditionalForeignKey(ForeignKey foreignKey)
PersistencePackageRequest	addCustomCriteria(String customCriteria)
PersistencePackageRequest	addCustomCriteria(String[] customCriteriaList)
PersistencePackageRequest	addFilterAndSortCriteria(List<FilterAndSortCriteria> filterAndSortCriteria)
PersistencePackageRequest	addFilterAndSortCriteria(FilterAndSortCriteria filterAndSortCriteria)
PersistencePackageRequest	addFilterAndSortCriteria(FilterAndSortCriteria[] filterAndSortCriteria)
PersistencePackageRequest	addSubRequest(String infoPropertyName, PersistencePackageRequest subRequest)
static PersistencePackageRequest	adorned()
PersistencePackageRequest	clearFilterAndSortCriteria()
static PersistencePackageRequest	fromMetadata(FieldMetadata md, List<SectionCrumb> sectionCrumbs)	Creates a semi-populate PersistencePacakageRequest based on the specified Metadata.
ForeignKey[]	getAdditionalForeignKeys()
AdornedTargetList	getAdornedList()
String	getCeilingEntityClassname()
String	getConfigKey()
String[]	getCustomCriteria()
Entity	getEntity()
FilterAndSortCriteria[]	getFilterAndSortCriteria()
Long	getFirstId()	Intended for usage with other than FetchType.DEFAULT.
Long	getFolderId()
ForeignKey	getForeignKey()
Long	getLastId()	Intended for usage with other than FetchType.DEFAULT.
Integer	getLowerCount()	Intended for usage with other than FetchType.DEFAULT.
MapStructure	getMapStructure()
Integer	getMaxIndex()
Integer	getMaxResults()
String	getMsg()
OperationTypes	getOperationTypesOverride()
Integer	getPageSize()	The number of records to retrieve in a single page.
Boolean	getPresentationFetch()	Whether or not this represents a fetch request from the presentation layer.
String	getRequestingEntityName()
SectionCrumb[]	getSectionCrumbs()
String	getSectionEntityField()
String	getSecurityCeilingEntityClassname()	Returns the entity that should be checked for security purposes.
Integer	getStartIndex()
Map<String,PersistencePackageRequest>	getSubRequests()
PersistencePackageRequest.Type	getType()
Integer	getUpperCount()	Intended for usage with other than FetchType.DEFAULT.
boolean	hasSortCriteria()
boolean	isAddOperationInspect()
boolean	isFolderedLookup()	Tells if this PersistentPackageRequest is a lookup that will end up foldered
boolean	isTreeCollection()
boolean	isUpdateLookupType()
boolean	isValidateUnsubmittedProperties()
static PersistencePackageRequest	map()
PersistencePackageRequest	removeFilterAndSortCriteria(String name)
void	setAdditionalForeignKeys(ForeignKey[] additionalForeignKeys)
void	setAddOperationInspect(boolean addOperationInspect)
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	setFirstId(Long firstId)
void	setFolderedLookup(boolean isFolderedLookup)
void	setFolderId(Long folderId)
void	setForeignKey(ForeignKey foreignKey)
void	setIsTreeCollection(boolean isTreeCollection)
void	setLastId(Long lastId)
void	setLowerCount(Integer lowerCount)
void	setMapStructure(MapStructure mapStructure)
void	setMaxIndex(Integer maxIndex)
void	setMaxResults(Integer maxResults)
void	setMsg(String msg)
void	setOperationTypesOverride(OperationTypes operationTypesOverride)
void	setPageSize(Integer pageSize)
void	setPresentationFetch(Boolean presentationFetch)
void	setRequestingEntityName(String requestingEntityName)
void	setSectionCrumbs(SectionCrumb[] sectionCrumbs)
void	setSectionEntityField(String sectionEntityField)
void	setSecurityCeilingEntityClassname(String securityCeilingEntityClassname)
void	setStartIndex(Integer startIndex)
void	setSubRequests(Map<String,PersistencePackageRequest> subRequests)
void	setType(PersistencePackageRequest.Type type)
void	setUpdateLookupType(boolean isUpdateLookupType)
void	setUpperCount(Integer upperCount)
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	withFirstId(Long firstId)
PersistencePackageRequest	withFolderId(Long folderId)
PersistencePackageRequest	withForeignKey(ForeignKey foreignKey)
PersistencePackageRequest	withIsFolderedLookup(boolean isFolderedLookup)
PersistencePackageRequest	withIsUpdateLookupType(boolean isUpdateLookupType)
PersistencePackageRequest	withLastId(Long lastId)
PersistencePackageRequest	withLowerCount(Integer lowerCount)
PersistencePackageRequest	withMapStructure(MapStructure mapStructure)
PersistencePackageRequest	withMaxIndex(Integer maxIndex)
PersistencePackageRequest	withMaxResults(Integer maxResults)
PersistencePackageRequest	withMsg(String msg)
PersistencePackageRequest	withPageSize(Integer pageSize)
PersistencePackageRequest	withPresentationFetch(Boolean presentationFetch)
PersistencePackageRequest	withRequestingEntityName(String requestingEntityName)
PersistencePackageRequest	withSectionCrumbs(List<SectionCrumb> sectionCrumbs)
PersistencePackageRequest	withSectionEntityField(String sectionEntityField)
PersistencePackageRequest	withSecurityCeilingEntityClassname(String className)
PersistencePackageRequest	withStartIndex(Integer startIndex)
PersistencePackageRequest	withType(PersistencePackageRequest.Type type)
PersistencePackageRequest	withUpperCount(Integer upperCount)

Methods inherited from class java.lang.Object

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

Field Details

type

protected PersistencePackageRequest.Type type

ceilingEntityClassname

protected String ceilingEntityClassname

securityCeilingEntityClassname

protected String securityCeilingEntityClassname

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

maxResults

protected Integer maxResults

lastId

protected Long lastId

firstId

protected Long firstId

upperCount

protected Integer upperCount

lowerCount

protected Integer lowerCount

pageSize

protected Integer pageSize

presentationFetch

protected Boolean presentationFetch

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

isUpdateLookupType

protected boolean isUpdateLookupType

isTreeCollection

protected boolean isTreeCollection

isAddOperationInspect

protected boolean isAddOperationInspect

isFolderedLookup

protected boolean isFolderedLookup

folderId

protected Long folderId

operationTypesOverride

protected OperationTypes operationTypesOverride

additionalForeignKeys

protected List<ForeignKey> additionalForeignKeys

customCriteria

protected List<String> customCriteria

filterAndSortCriteria

protected List<FilterAndSortCriteria> filterAndSortCriteria

Constructor Details

PersistencePackageRequest

public PersistencePackageRequest()

PersistencePackageRequest

public PersistencePackageRequest(PersistencePackageRequest.Type type)

Method Details

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 Metadata. 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)

withSecurityCeilingEntityClassname

public PersistencePackageRequest withSecurityCeilingEntityClassname(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)

withMaxResults

public PersistencePackageRequest withMaxResults(Integer maxResults)

withLastId

public PersistencePackageRequest withLastId(Long lastId)

withFirstId

public PersistencePackageRequest withFirstId(Long firstId)

withUpperCount

public PersistencePackageRequest withUpperCount(Integer upperCount)

withLowerCount

public PersistencePackageRequest withLowerCount(Integer lowerCount)

withPageSize

public PersistencePackageRequest withPageSize(Integer pageSize)

withPresentationFetch

public PersistencePackageRequest withPresentationFetch(Boolean presentationFetch)

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)

withIsUpdateLookupType

public PersistencePackageRequest withIsUpdateLookupType(boolean isUpdateLookupType)

withIsFolderedLookup

public PersistencePackageRequest withIsFolderedLookup(boolean isFolderedLookup)

withFolderId

public PersistencePackageRequest withFolderId(Long folderId)

addAdditionalForeignKey

public PersistencePackageRequest addAdditionalForeignKey(ForeignKey foreignKey)

addSubRequest

public PersistencePackageRequest addSubRequest(String infoPropertyName,
 PersistencePackageRequest subRequest)

addCustomCriteria

public PersistencePackageRequest addCustomCriteria(String customCriteria)

addCustomCriteria

public PersistencePackageRequest addCustomCriteria(String[] customCriteriaList)

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)

clearFilterAndSortCriteria

public PersistencePackageRequest clearFilterAndSortCriteria()

hasSortCriteria

public boolean hasSortCriteria()

getCustomCriteria

public String[] getCustomCriteria()

setCustomCriteria

public void setCustomCriteria(String[] customCriteria)

getAdditionalForeignKeys

public ForeignKey[] getAdditionalForeignKeys()

setAdditionalForeignKeys

public void setAdditionalForeignKeys(ForeignKey[] additionalForeignKeys)

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)

getSecurityCeilingEntityClassname

public String getSecurityCeilingEntityClassname()

Returns the entity that should be checked for security purposes. If no value is defined explicitly, returns the value for getCeilingEntityClassname().

Returns:

setSecurityCeilingEntityClassname

public void setSecurityCeilingEntityClassname(String securityCeilingEntityClassname)

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)

getMaxResults

public Integer getMaxResults()

setMaxResults

public void setMaxResults(Integer maxResults)

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)

isUpdateLookupType

public boolean isUpdateLookupType()

setUpdateLookupType

public void setUpdateLookupType(boolean isUpdateLookupType)

isTreeCollection

public boolean isTreeCollection()

setIsTreeCollection

public void setIsTreeCollection(boolean isTreeCollection)

isAddOperationInspect

public boolean isAddOperationInspect()

setAddOperationInspect

public void setAddOperationInspect(boolean addOperationInspect)

getLastId

public Long getLastId()

Intended for usage with other than FetchType.DEFAULT. Denotes the last primary key value of the previous page of records.

Returns:

setLastId

public void setLastId(Long lastId)

getFirstId

public Long getFirstId()

Intended for usage with other than FetchType.DEFAULT. Denotes the first primary key value of the previous page or records.

setFirstId

public void setFirstId(Long firstId)

getUpperCount

public Integer getUpperCount()

Intended for usage with other than FetchType.DEFAULT. Denotes the cumulative total count of the previous page of records. For example, if this was the second page of records and each page contained 5 records, the upperCount would be 10.

Returns:

setUpperCount

public void setUpperCount(Integer upperCount)

getLowerCount

public Integer getLowerCount()

Intended for usage with other than FetchType.DEFAULT. Denotes the cumulative starting count of the previous page of records. For example, if this was the second page of records and each page contained 5 records, the lowerCount would be 5.

setLowerCount

public void setLowerCount(Integer lowerCount)

getPageSize

public Integer getPageSize()

The number of records to retrieve in a single page. If null, defaults to the "admin.default.max.results" property value.

Returns:

setPageSize

public void setPageSize(Integer pageSize)

getPresentationFetch

public Boolean getPresentationFetch()

Whether or not this represents a fetch request from the presentation layer.

Returns:

setPresentationFetch

public void setPresentationFetch(Boolean presentationFetch)

isFolderedLookup

public boolean isFolderedLookup()

Tells if this PersistentPackageRequest is a lookup that will end up foldered

Returns:

true if this is a foldered lookup, false otherwise

setFolderedLookup

public void setFolderedLookup(boolean isFolderedLookup)

getFolderId

public Long getFolderId()

setFolderId

public void setFolderId(Long folderId)