Package mc.core.model.channel

Class PublicationProfile

java.lang.Object
mc.core.model.base.EntityBase
mc.core.model.base.ComplexEntity
mc.core.model.channel.ProfileBase
mc.core.model.channel.PublicationProfile
All Implemented Interfaces:
Serializable, IBaseEntity, ICollectionManaged, ICoreEntity, IEntity, IRightManaged, ISortableEntity, IStateManaged, ITypeManaged, IChannelMapHolder<PublicationProfileMap>, ISchedulable
@Entity public class PublicationProfile extends ProfileBase implements IStateManaged, IRightManaged, ICollectionManaged, IChannelMapHolder<PublicationProfileMap>
Entity to define a type of publication that can be run repeatedly, each run being represented by entity Publication. PublicationProfile is always associated with a PublicationProfileType that holds the configuration for this PublicationProfile. navigationHrcs: give the NavigationHrc that contain and structure the Nodes that should be exported
publicationMaps: contain the publication filters, which entities are to be exported and what of their data
classificationHrc: gives the hierarchy of which the classifications are to be exported and their assignments to the Nodes with their attributes and values.
publicationProfileLocales: define primary locale and optional additional locales, each with optional replacement locales. There must one and only one PublicationProfileLocale marked as primary. Primary locale is the locale in which is all locale dependent content published. If no content in primary locale exists the replacement locale is used if given. Additional locales provided the possibility for multilingual publications.
PubliationProfiles are grouped in collections, are right managed if so configured by PublicationProfileType and can have attributes of subtype PRESENTATION to fine tune display in publication.
See Also:

  • Constructor Details

    • PublicationProfile

      public PublicationProfile()

    • PublicationProfile

      public PublicationProfile(PublicationProfile source)

  • Method Details

    • getNavigationHrcs

      public List<NavigationHrc> getNavigationHrcs()

    • addNavigationHrc

      public void addNavigationHrc(NavigationHrc navigationHrc, int prio)

    • getPublicationProfileToNavigationHrcs

      public List<PublicationProfileToNavigationHrc> getPublicationProfileToNavigationHrcs()

    • getPublicationProfileType

      public PublicationProfileType getPublicationProfileType()

    • setPublicationProfileType

      public void setPublicationProfileType(PublicationProfileType publicationProfileType)

    • setType

      public void setType(ComplexTypeEntity type)
      Description copied from class: ComplexEntity
      override in derived classes if ComplexEntity-subclass is type managed, else do nothing.
      be used by entity mapper
      Overrides:
      setType in class ComplexEntity

    • getPricelists

      public List<Pricelist> getPricelists()
      Overrides:
      getPricelists in class ProfileBase

    • getPublicationMaps

      public List<PublicationProfileMap> getPublicationMaps()

    • setPublicationMaps

      public void setPublicationMaps(List<PublicationProfileMap> exportMaps)

    • addPublicationMap

      public void addPublicationMap(PublicationProfileMap pubMap)

    • getClassificationHrc

      public ClassificationHrc getClassificationHrc()

    • setClassificationHrc

      public void setClassificationHrc(ClassificationHrc classificationHrc)

    • getPublicationProfileLocales

      public List<PublicationProfileLocale> getPublicationProfileLocales()

    • setPublicationProfileLocales

      public void setPublicationProfileLocales(List<PublicationProfileLocale> publicationProfileLocales)

    • addPublicationProfileLocale

      public void addPublicationProfileLocale(PublicationProfileLocale profileLocale)

    • getPublications

      public List<Publication> getPublications()

    • setPublications

      public void setPublications(List<Publication> publications)

    • isDeltaPublication

      public boolean isDeltaPublication()

    • setDeltaPublication

      public void setDeltaPublication(boolean deltaPublication)

    • isSearchResultPublication

      public boolean isSearchResultPublication()

    • setSearchResultPublication

      public void setSearchResultPublication(boolean searchResultPublication)

    • getAllowedRightTypes

      public RightType[] getAllowedRightTypes()
      Description copied from interface: IRightManaged
      give the maximum list of RightTypes that apply for this class.
      Specified by:
      getAllowedRightTypes in interface IRightManaged
      Returns:
      array of enum RightType

    • getType

      public ComplexTypeEntity getType()
      Description copied from class: ComplexEntity
      override in derived classes, return null if ComplexEntity-subclass is not type managed.
      Specified by:
      getType in interface ICollectionManaged
      Specified by:
      getType in interface ITypeManaged
      Specified by:
      getType in class ComplexEntity

    • getProfileType

      public ProfileTypeBase getProfileType()
      Specified by:
      getProfileType in class ProfileBase

    • isRootPerType

      public boolean isRootPerType()
      Description copied from interface: ICollectionManaged
      Flag that indicates if the entities have a root collection per type or if there is only one global root collection. if rootPerType true it can only apply to entities that have a type, i.e. ComplexEntities.
      Specified by:
      isRootPerType in interface ICollectionManaged

    • getPublicationMap

      public ChannelMapBase getPublicationMap()
      PublicationProfile for flatFile only has one map.
      CAUTION: fallback to map of PubProfileType. do not use returned map for editing!
      Returns:
      first PublicationProfileMap if any, else first PublicationProfileTypeMap if any

    • getChannelMap

      public ChannelMapBase getChannelMap(boolean useType)
      ProfileBase contract
      Specified by:
      getChannelMap in class ProfileBase

    • getChannelMaps

      public List<PublicationProfileMap> getChannelMaps()
      IChannelMapHolder contract
      Specified by:
      getChannelMaps in interface IChannelMapHolder<PublicationProfileMap>
      Returns:
      list of channel maps if any or empty list. no fallback from profile to type

    • getChannelMapInstance

      public PublicationProfileMap getChannelMapInstance()
      IChannelMapHolder contract
      Specified by:
      getChannelMapInstance in interface IChannelMapHolder<PublicationProfileMap>
      Returns:
      a new instance of the appropriate subclass of ChannelMapBase and set this as channelMapHolder

    • getPrimaryLocale

      public Locale getPrimaryLocale()
      Returns:
      Locale: the primary locale for the publication if exist, otherwise null

    • getReplacementLocale

      public Locale getReplacementLocale()
      Returns:
      Locale: replacement locale of primary locale if exist, otherwise null

    • getPPAdditionalLocales

      public List<PublicationProfileLocale> getPPAdditionalLocales()
      Returns:
      list of PublicationProfileLocales that serve as additional locales if exist, otherwise empty list.

    • isIncludeInherited

      public boolean isIncludeInherited()
      Returns:
      where inherited attribute values should be included (flag stored as EntityParameter)

    • getTemplateData

      public String getTemplateData()
      Returns:
      data of EntityDataCE with key templateData (velocity template file name)