PersistencePackage (BroadleafCommerce 4.0.18-GA API)

java.lang.Object
- org.broadleafcommerce.openadmin.dto.PersistencePackage

All Implemented Interfaces:: Serializable, StateDescriptor

public class PersistencePackage
extends Object
implements Serializable, StateDescriptor

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`ceilingEntityFullyQualifiedClassname`
`protected String`	`csrfToken`
`protected String[]`	`customCriteria`
`protected Entity`	`entity`
`protected String`	`fetchTypeFullyQualifiedClassname`
`protected boolean`	`isProcessedInternal`
`protected PersistencePerspective`	`persistencePerspective`
`protected String`	`requestingEntityName`
`protected SectionCrumb[]`	`sectionCrumbs`
`protected String`	`sectionEntityField`
`protected String`	`securityCeilingEntityFullyQualifiedClassname`
`protected Map<String,PersistencePackage>`	`subPackages`
`protected boolean`	`validateUnsubmittedProperties`

Constructor Summary

Constructors
Constructor and Description
`PersistencePackage()`
`PersistencePackage(String ceilingEntityFullyQualifiedClassname, Entity entity, PersistencePerspective persistencePerspective, String[] customCriteria, String csrfToken)`
`PersistencePackage(String ceilingEntityFullyQualifiedClassname, String fetchTypeFullyQualifiedClassname, Entity entity, PersistencePerspective persistencePerspective, String[] customCriteria, String csrfToken)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCustomCriteria(String criteria)`
`int`	`containsCriteria(String criteria)`
`boolean`	`equals(Object o)`
`Property`	`findProperty(String name)`
`SectionCrumb`	`getBottomCrumb()`
`String`	`getCeilingEntityFullyQualifiedClassname()`
`SectionCrumb`	`getClosetCrumb(String myCeiling)`
`String`	`getCsrfToken()`
`String[]`	`getCustomCriteria()`
`Entity`	`getEntity()`
`String`	`getFetchTypeFullyQualifiedClassname()`
`PersistencePerspective`	`getPersistencePerspective()`
`Map<PersistencePerspectiveItemType,PersistencePerspectiveItem>`	`getPersistencePerspectiveItems()`
`Map<String,Property>`	`getPMap()`
`Property[]`	`getProperties()`
`String`	`getRequestingEntityName()`
`SectionCrumb[]`	`getSectionCrumbs()`
`String`	`getSectionEntityField()`
`String`	`getSecurityCeilingEntityFullyQualifiedClassname()`
`Map<String,PersistencePackage>`	`getSubPackages()`
`SectionCrumb`	`getTopCrumb()`
`int`	`hashCode()`
`boolean`	`isProcessedInternal()` Internally used field when passing the persistence package through the admin pipeline
`boolean`	`isValidateUnsubmittedProperties()`
`void`	`removeCustomCriteria(String criteria)`
`void`	`setCeilingEntityFullyQualifiedClassname(String ceilingEntityFullyQualifiedClassname)`
`void`	`setCsrfToken(String csrfToken)`
`void`	`setCustomCriteria(String[] customCriteria)`
`void`	`setEntity(Entity entity)`
`void`	`setFetchTypeFullyQualifiedClassname(String fetchTypeFullyQualifiedClassname)`
`void`	`setPersistencePerspective(PersistencePerspective persistencePerspective)`
`void`	`setProcessedInternal(boolean isProcessedInternal)` Internally used field when passing the persistence package through the admin pipeline
`void`	`setRequestingEntityName(String requestingEntityName)`
`void`	`setSectionCrumbs(SectionCrumb[] sectionCrumbs)`
`void`	`setSectionEntityField(String sectionEntityField)`
`void`	`setSecurityCeilingEntityFullyQualifiedClassname(String securityCeilingEntityFullyQualifiedClassname)`
`void`	`setSubPackages(Map<String,PersistencePackage> subPackages)`
`void`	`setValidateUnsubmittedProperties(boolean validateUnsubmittedProperties)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ceilingEntityFullyQualifiedClassname

protected String ceilingEntityFullyQualifiedClassname

securityCeilingEntityFullyQualifiedClassname

protected String securityCeilingEntityFullyQualifiedClassname

sectionEntityField
```
protected String sectionEntityField
```

fetchTypeFullyQualifiedClassname

protected String fetchTypeFullyQualifiedClassname

persistencePerspective

protected PersistencePerspective persistencePerspective

customCriteria
```
protected String[] customCriteria
```

entity
```
protected Entity entity
```

csrfToken
```
protected String csrfToken
```

requestingEntityName
```
protected String requestingEntityName
```

subPackages

protected Map<String,PersistencePackage> subPackages

validateUnsubmittedProperties

protected boolean validateUnsubmittedProperties

sectionCrumbs
```
protected SectionCrumb[] sectionCrumbs
```

isProcessedInternal
```
protected boolean isProcessedInternal
```

Constructor Detail

PersistencePackage

public PersistencePackage(String ceilingEntityFullyQualifiedClassname,
                  Entity entity,
                  PersistencePerspective persistencePerspective,
                  String[] customCriteria,
                  String csrfToken)

PersistencePackage

public PersistencePackage(String ceilingEntityFullyQualifiedClassname,
                  String fetchTypeFullyQualifiedClassname,
                  Entity entity,
                  PersistencePerspective persistencePerspective,
                  String[] customCriteria,
                  String csrfToken)

PersistencePackage
```
public PersistencePackage()
```

Method Detail

findProperty
```
public Property findProperty(String name)
```
Specified by:

findProperty in interface StateDescriptor

getProperties
```
public Property[] getProperties()
```
Specified by:

getProperties in interface StateDescriptor

getPMap
```
public Map<String,Property> getPMap()
```
Specified by:

getPMap in interface StateDescriptor

getCeilingEntityFullyQualifiedClassname

public String getCeilingEntityFullyQualifiedClassname()

setCeilingEntityFullyQualifiedClassname

public void setCeilingEntityFullyQualifiedClassname(String ceilingEntityFullyQualifiedClassname)

getSecurityCeilingEntityFullyQualifiedClassname

public String getSecurityCeilingEntityFullyQualifiedClassname()

setSecurityCeilingEntityFullyQualifiedClassname

public void setSecurityCeilingEntityFullyQualifiedClassname(String securityCeilingEntityFullyQualifiedClassname)

getPersistencePerspective

public PersistencePerspective getPersistencePerspective()

setPersistencePerspective

public void setPersistencePerspective(PersistencePerspective persistencePerspective)

getCustomCriteria
```
public String[] getCustomCriteria()
```

setCustomCriteria

public void setCustomCriteria(String[] customCriteria)

addCustomCriteria

public void addCustomCriteria(String criteria)

removeCustomCriteria

public void removeCustomCriteria(String criteria)

containsCriteria

public int containsCriteria(String criteria)

getEntity
```
public Entity getEntity()
```

setEntity
```
public void setEntity(Entity entity)
```

getCsrfToken
```
public String getCsrfToken()
```

setCsrfToken

public void setCsrfToken(String csrfToken)

getFetchTypeFullyQualifiedClassname

public String getFetchTypeFullyQualifiedClassname()

setFetchTypeFullyQualifiedClassname

public void setFetchTypeFullyQualifiedClassname(String fetchTypeFullyQualifiedClassname)

getSectionEntityField
```
public String getSectionEntityField()
```

setSectionEntityField

public void setSectionEntityField(String sectionEntityField)

getRequestingEntityName

public String getRequestingEntityName()

setRequestingEntityName

public void setRequestingEntityName(String requestingEntityName)

getPersistencePerspectiveItems

public Map<PersistencePerspectiveItemType,PersistencePerspectiveItem> getPersistencePerspectiveItems()

getSubPackages

public Map<String,PersistencePackage> getSubPackages()

setSubPackages

public void setSubPackages(Map<String,PersistencePackage> subPackages)

isValidateUnsubmittedProperties

public boolean isValidateUnsubmittedProperties()

setValidateUnsubmittedProperties

public void setValidateUnsubmittedProperties(boolean validateUnsubmittedProperties)

getSectionCrumbs

public SectionCrumb[] getSectionCrumbs()

setSectionCrumbs

public void setSectionCrumbs(SectionCrumb[] sectionCrumbs)

getClosetCrumb

public SectionCrumb getClosetCrumb(String myCeiling)

getBottomCrumb
```
public SectionCrumb getBottomCrumb()
```

getTopCrumb
```
public SectionCrumb getTopCrumb()
```

isProcessedInternal
```
public boolean isProcessedInternal()
```
Internally used field when passing the persistence package through the admin pipeline

Returns:
whether or not this persistence package has been exposed to a internal processing step

setProcessedInternal
```
public void setProcessedInternal(boolean isProcessedInternal)
```
Internally used field when passing the persistence package through the admin pipeline

Parameters:
isProcessedInternal - whether or not this persistence package has been exposed to a internal processing step

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class PersistencePackage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ceilingEntityFullyQualifiedClassname

securityCeilingEntityFullyQualifiedClassname

sectionEntityField

fetchTypeFullyQualifiedClassname

persistencePerspective

customCriteria

entity

csrfToken

requestingEntityName

subPackages

validateUnsubmittedProperties

sectionCrumbs

isProcessedInternal

Constructor Detail

PersistencePackage

PersistencePackage

PersistencePackage

Method Detail

findProperty

getProperties

getPMap

getCeilingEntityFullyQualifiedClassname

setCeilingEntityFullyQualifiedClassname

getSecurityCeilingEntityFullyQualifiedClassname

setSecurityCeilingEntityFullyQualifiedClassname

getPersistencePerspective

setPersistencePerspective

getCustomCriteria

setCustomCriteria

addCustomCriteria

removeCustomCriteria

containsCriteria

getEntity

setEntity

getCsrfToken

setCsrfToken

getFetchTypeFullyQualifiedClassname

setFetchTypeFullyQualifiedClassname

getSectionEntityField

setSectionEntityField

getRequestingEntityName

setRequestingEntityName

getPersistencePerspectiveItems

getSubPackages

setSubPackages

isValidateUnsubmittedProperties

setValidateUnsubmittedProperties

getSectionCrumbs

setSectionCrumbs

getClosetCrumb

getBottomCrumb

getTopCrumb

isProcessedInternal

setProcessedInternal

toString

equals

hashCode