Package mc.core.domain.channel.dobj
Class PublicationProfileDO
java.lang.Object
mc.core.system.base.BaseBean
mc.core.domain.base.dobj.AbstractBaseDO<T>
mc.core.domain.base.dobj.AbstractEntityBaseDO<T>
mc.core.domain.base.dobj.AbstractComplexEntityDO<PublicationProfile>
mc.core.domain.channel.dobj.PublicationProfileDO
- All Implemented Interfaces:
IBaseDO<PublicationProfile>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classwrapper around DataMapNested classes/interfaces inherited from class mc.core.domain.base.dobj.AbstractBaseDO
AbstractBaseDO.Initializer -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddNavigationHierarchy(PublicationProfile publicationProfile, NavigationHrc navigationHrc) voidchangeOrderOfNavigationHierarchies(PublicationProfile publicationProfile, NavigationHrc navigationHrc, boolean decreaseOrder) voidchangeOrderOfNavigationHierarchies(PublicationProfile publicationProfile, NavigationHrc navigationHrc, int targetPosition) copy(PublicationProfile publicationProfile, Collection targetCollection) voiddelete(PublicationProfile publicationProfile, boolean force) NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!getForObjectType(ComplexTypeEntity objectType) return all publicationProfiles with flag searchResultPublication=true and RightType.EXECUTE for current usergetForSearchResult(mc.core.system.search.SearchResult searchResult) Returns all publicationProfiles with flag searchResultPublication=true and, if profileType=flatFile, where nodeType of publication map equals nodeType of nodes in search result.getLayoutProfile(NavigationHrc navigationHrc) mc.core.system.util.misc.StringMapvoidperformExport(PublicationProfile publicationProfile, String searchResultId) starts exportvoidperformExport(PublicationProfile publicationProfile, List<Long> searchResultIds) Starts the export defined by this publicationProfile and with data from an earlier search.voidperformExport(PublicationProfile publicationProfile, Basket basket) voidperformExport(PublicationProfile publicationProfile, mc.core.system.search.SearchResult searchResult) Starts the export defined by this publicationProfile and with data from an earlier search.voidremoveNavigationHierarchy(PublicationProfile publicationProfile, NavigationHrc navigationHrc) voidremovePublicationMap(PublicationProfile publicationProfile, PublicationProfileMap publicationMap) save(PublicationProfile publicationProfile, DataMap dataMap) map data to entity if any, validate and savevoidsearchFilterAdd(PublicationProfile publicationProfile, String key, mc.core.system.search.SearchFilter sf) Deprecated, for removal: This API element is subject to removal in a future version.voidsearchFilterDelete(PublicationProfile publicationProfile, String searchFilterId) Delete Map entry of saved Search filters on publication profilevoidsearchFilterDelete(PublicationProfile publicationProfile, mc.core.system.search.SearchFilter sf) Delete Map entry of saved Search filters on publication profilemc.core.system.search.SearchFiltersearchFilterGetActive(PublicationProfile publicationProfile) Deprecated, for removal: This API element is subject to removal in a future version.searchFilterMapGet(PublicationProfile publicationProfile) Get List of PubProfileSearchData with saved Search filters on publication profilevoidsearchFilterMapSave(PublicationProfile publicationProfile, List<PublicationProfileDO.PubProfileSearchData> existing) Save List of PubProfileSearchData on publication profilevoidsetLocales(PublicationProfile publicationProfile, List<PublicationProfileLocale> ppLocales) Methods inherited from class mc.core.domain.base.dobj.AbstractComplexEntityDO
addDefaultSearchCriteria, assertPermission, assertPermission, attributes, copy, copyDataSync, copyToCollection, doRecursiveActionAsync, edit, entityProfileApply, entityProfileApply, filter, getCollectionHierarchies, getCollectionsAll, getFromExternalKey, getFromKeySearchFilter, getUserRole, insert, lifecycle, newComplexEntityEvent, onChange, parameter, permissions, prepareSearchFilter, relations, secondaryCollectionAdd, secondaryCollectionCopy, secondaryCollectionMove, secondaryCollectionRemove, setRightInheritanceDisabled, states, translate, versions, watchesMethods inherited from class mc.core.domain.base.dobj.AbstractEntityBaseDO
getFromInternalDescription, sendEvent, sendEventMethods inherited from class mc.core.domain.base.dobj.AbstractBaseDO
delete, getAll, getAllActive, getEntityDisplay, getFromId, getFromKey, getOne, map, map, save, validator
-
Constructor Details
-
PublicationProfileDO
public PublicationProfileDO()
-
-
Method Details
-
save
public PublicationProfile save(PublicationProfile publicationProfile, DataMap dataMap) throws ApplicationException Description copied from interface:IBaseDOmap data to entity if any, validate and save- Specified by:
savein interfaceIBaseDO<PublicationProfile>- Overrides:
savein classAbstractEntityBaseDO<PublicationProfile>- Parameters:
publicationProfile- mandatorydataMap- optional- Returns:
- mapped entity
- Throws:
ApplicationException
-
copy
public PublicationProfile copy(PublicationProfile publicationProfile, Collection targetCollection) throws ApplicationException - Throws:
ApplicationException
-
delete
public void delete(PublicationProfile publicationProfile, boolean force) throws ApplicationException Description copied from class:AbstractBaseDONOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!- Overrides:
deletein classAbstractComplexEntityDO<PublicationProfile>- Parameters:
publicationProfile- mandatoryforce- if true delete without usage check, which can result in db constraints error unless references are taken care of- Throws:
ApplicationException
-
setLocales
public void setLocales(PublicationProfile publicationProfile, List<PublicationProfileLocale> ppLocales) throws ApplicationException - Throws:
ApplicationException
-
getTemplatesMap
public mc.core.system.util.misc.StringMap getTemplatesMap()- Returns:
- all velocity templates file names with prefix "template_"
from [mc.root]/namespaces/[namespace]/templates
-
removePublicationMap
public void removePublicationMap(PublicationProfile publicationProfile, PublicationProfileMap publicationMap) throws ApplicationException - Throws:
ApplicationException
-
performExport
public void performExport(PublicationProfile publicationProfile, String searchResultId) throws ApplicationException starts export- Parameters:
publicationProfile- mandatorysearchResultId- optional- Throws:
ApplicationException
-
performExport
public void performExport(PublicationProfile publicationProfile, mc.core.system.search.SearchResult searchResult) throws ApplicationException Starts the export defined by this publicationProfile and with data from an earlier search.
required right: RightType.EXECUTE by publicationProfile
- Parameters:
publicationProfile- Description for export contents. Must not benull.searchResult- Result of an earlier search. Optional- Throws:
UserException- with message keymessage.workflow.info.startedto signal start of workflow.ApplicationException- on any error
-
performExport
public void performExport(PublicationProfile publicationProfile, List<Long> searchResultIds) throws ApplicationException Starts the export defined by this publicationProfile and with data from an earlier search.
required right: RightType.EXECUTE by publicationProfile
- Parameters:
publicationProfile- Description for export contents. Must not benull.searchResultIds- Result of an earlier search. Optional- Throws:
UserException- with message keymessage.workflow.info.startedto signal start of workflow.ApplicationException- on any error
-
performExport
public void performExport(PublicationProfile publicationProfile, Basket basket) throws ApplicationException - Throws:
ApplicationException
-
getForSearchResult
public List<PublicationProfile> getForSearchResult(mc.core.system.search.SearchResult searchResult) throws ApplicationException Returns all publicationProfiles with flag searchResultPublication=true and, if profileType=flatFile, where nodeType of publication map equals nodeType of nodes in search result.- Parameters:
searchResult- optional. currently not used- Returns:
- Matching publication profiles.
- Throws:
ApplicationException
-
getForObjectType
return all publicationProfiles with flag searchResultPublication=true and RightType.EXECUTE for current user- Parameters:
objectType- optional. currently not used- Returns:
- list of matching publicationProfiles
-
searchFilterAdd
@Deprecated(forRemoval=true) public void searchFilterAdd(PublicationProfile publicationProfile, String key, mc.core.system.search.SearchFilter sf) throws ApplicationException Deprecated, for removal: This API element is subject to removal in a future version.Add entry to Map of saved Search filters on publication profile- Parameters:
publicationProfile-key-sf-- Throws:
ApplicationException
-
searchFilterMapSave
public void searchFilterMapSave(PublicationProfile publicationProfile, List<PublicationProfileDO.PubProfileSearchData> existing) throws ApplicationException Save List of PubProfileSearchData on publication profile- Parameters:
publicationProfile-existing- List of PubProfileSearchData- Throws:
ApplicationException
-
searchFilterDelete
public void searchFilterDelete(PublicationProfile publicationProfile, mc.core.system.search.SearchFilter sf) throws ApplicationException Delete Map entry of saved Search filters on publication profile- Parameters:
publicationProfile-sf-- Throws:
ApplicationException
-
searchFilterDelete
public void searchFilterDelete(PublicationProfile publicationProfile, String searchFilterId) throws ApplicationException Delete Map entry of saved Search filters on publication profile- Parameters:
publicationProfile-sf-- Throws:
ApplicationException
-
searchFilterMapGet
public List<PublicationProfileDO.PubProfileSearchData> searchFilterMapGet(PublicationProfile publicationProfile) throws ApplicationException Get List of PubProfileSearchData with saved Search filters on publication profile- Parameters:
publicationProfile-- Returns:
- List of PubProfileSearchData
- Throws:
ApplicationException
-
searchFilterGetActive
@Deprecated(forRemoval=true) public mc.core.system.search.SearchFilter searchFilterGetActive(PublicationProfile publicationProfile) Deprecated, for removal: This API element is subject to removal in a future version.Get (first) active Search filter on publication profile- Parameters:
publicationProfile-- Returns:
- filter or null
-