Class CometPlaceholder

All Implemented Interfaces:
CometContextRuleConfiguration, CometDataProviderLink, Serializable

Java class for the Placeholder configuration type

See Also:
  • Field Details

  • Constructor Details

    • CometPlaceholder

      public CometPlaceholder()
      Instantiates a new Comet placeholder.
  • Method Details

    • getActive

      public Boolean getActive()
      Gets active.
      Returns:
      the active
    • getAutoSync

      public Boolean getAutoSync()
      Gets auto sync.
      Returns:
      the auto sync
    • getColorId

      public Integer getColorId()
      Gets color id.
      Returns:
      the color id
    • getContextRuleAssortment

      public PluginMethod getContextRuleAssortment()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule assortment.
      Specified by:
      getContextRuleAssortment in interface CometContextRuleConfiguration
      Returns:
      the context rule assortment
    • getContextRuleCountry

      public PluginMethod getContextRuleCountry()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule country.
      Specified by:
      getContextRuleCountry in interface CometContextRuleConfiguration
      Returns:
      the context rule country
    • getContextRuleDocument

      public PluginMethod getContextRuleDocument()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule document.
      Specified by:
      getContextRuleDocument in interface CometContextRuleConfiguration
      Returns:
      the context rule document
    • getContextRuleLanguage

      public PluginMethod getContextRuleLanguage()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule language.
      Specified by:
      getContextRuleLanguage in interface CometContextRuleConfiguration
      Returns:
      the context rule language
    • getContextRulePublication

      public PluginMethod getContextRulePublication()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule publication.
      Specified by:
      getContextRulePublication in interface CometContextRuleConfiguration
      Returns:
      the context rule publication
    • getContextRuleWell

      public PluginMethod getContextRuleWell()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule well.
      Specified by:
      getContextRuleWell in interface CometContextRuleConfiguration
      Returns:
      the context rule well
    • getDataProcessingLoad

      public List<PluginMethod> getDataProcessingLoad()
      Description copied from interface: CometDataProviderLink
      Gets data processing load.
      Specified by:
      getDataProcessingLoad in interface CometDataProviderLink
      Returns:
      the data processing load
    • getDataProcessingStore

      public List<PluginMethod> getDataProcessingStore()
      Description copied from interface: CometDataProviderLink
      Gets data processing store.
      Specified by:
      getDataProcessingStore in interface CometDataProviderLink
      Returns:
      the data processing store
    • getDataProvider

      public CometPlaceholder.DataProvider getDataProvider()
      Description copied from interface: CometDataProviderLink
      Gets data provider.
      Specified by:
      getDataProvider in interface CometDataProviderLink
      Returns:
      the data provider
    • getDescription

      @CometDescription public String getDescription()
      Gets description.
      Returns:
      the description
    • getEntityId

      public String getEntityId()
      Gets entity id.
      Returns:
      the entity id
    • getLabel

      public String getLabel()
      Description copied from interface: CometDataProviderLink
      Gets label.
      Specified by:
      getLabel in interface CometDataProviderLink
      Returns:
      the label
    • getLoadConstraint

      public CometPlaceholder.LoadConstraint getLoadConstraint()
      Gets load constraint.
      Returns:
      the load constraint
    • getLoadId

      public Integer getLoadId()
      Gets load id.
      Returns:
      the load id
    • getLoadMethod

      public String getLoadMethod()
      Gets load method.
      Returns:
      the load method
    • getPlaceholderLabel

      @CometLabel public String getPlaceholderLabel()
      Gets placeholder label.
      Returns:
      the placeholder label
    • getPostfix

      public String getPostfix()
      Gets postfix.
      Returns:
      the postfix
    • getPostfixIfEmpty

      public String getPostfixIfEmpty()
      Gets postfix if empty.
      Returns:
      the postfix if empty
    • getPrefix

      public String getPrefix()
      Gets prefix.
      Returns:
      the prefix
    • getPrefixIfEmpty

      public String getPrefixIfEmpty()
      Gets prefix if empty.
      Returns:
      the prefix if empty
    • getRepositoryFilename

      public String getRepositoryFilename() throws CometException
      Description copied from class: CometEntity

      Gets the repository filename for this particular item

      This method MUST be overridden by classes extending CometEntity

      Overrides:
      getRepositoryFilename in class CometEntity
      Returns:
      the repository filename of this particular item
      Throws:
      CometException - the comet exception
    • getRepositoryPath

      public String getRepositoryPath() throws CometException
      Description copied from class: CometEntity

      Get the relative repository path for this configuration type.

      This method MUST be overridden by classes extending CometEntity.

      Overrides:
      getRepositoryPath in class CometEntity
      Returns:
      relative repository path
      Throws:
      CometException - the comet exception
    • getStoreAllowed

      public Boolean getStoreAllowed()
      Gets store allowed.
      Returns:
      the store allowed
    • getStoreId

      public Integer getStoreId()
      Gets store id.
      Returns:
      the store id
    • getStoreImagePlacement

      public Boolean getStoreImagePlacement()
      Gets store image placement.
      Returns:
      the store image placement
    • getStoreMethod

      public String getStoreMethod()
      Gets store method.
      Returns:
      the store method
    • getSyncId

      public Integer getSyncId()
      Gets sync id.
      Returns:
      the sync id
    • getSyncMethod

      public String getSyncMethod()
      Gets sync method.
      Returns:
      the sync method
    • getSyncStateVisible

      public Boolean getSyncStateVisible()
      Gets sync state visible.
      Returns:
      the sync state visible
    • getType

      Gets type.
      Returns:
      the type
    • getUseParent

      public Boolean getUseParent()
      Gets use parent.
      Returns:
      the use parent
    • getTag

      public String getTag()
      Gets tag.
      Returns:
      the tag
    • setActive

      public void setActive(Boolean active)
      Sets active.
      Parameters:
      active - the active
    • setAutoSync

      public void setAutoSync(Boolean autoSync)
      Sets auto sync.
      Parameters:
      autoSync - the auto sync
    • setColorId

      public void setColorId(Integer colorId)
      Sets color id.
      Parameters:
      colorId - the color id
    • setContextRuleAssortment

      public void setContextRuleAssortment(PluginMethod contextRuleAssortment)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule assortment.
      Specified by:
      setContextRuleAssortment in interface CometContextRuleConfiguration
      Parameters:
      contextRuleAssortment - the context rule assortment
    • setContextRuleCountry

      public void setContextRuleCountry(PluginMethod contextRuleCountry)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule country.
      Specified by:
      setContextRuleCountry in interface CometContextRuleConfiguration
      Parameters:
      contextRuleCountry - the context rule country
    • setContextRuleDocument

      public void setContextRuleDocument(PluginMethod contextRuleDocument)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule document.
      Specified by:
      setContextRuleDocument in interface CometContextRuleConfiguration
      Parameters:
      contextRuleDocument - the context rule document
    • setContextRuleLanguage

      public void setContextRuleLanguage(PluginMethod contextRuleLanguage)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule language.
      Specified by:
      setContextRuleLanguage in interface CometContextRuleConfiguration
      Parameters:
      contextRuleLanguage - the context rule language
    • setContextRulePublication

      public void setContextRulePublication(PluginMethod contextRulePublication)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule publication.
      Specified by:
      setContextRulePublication in interface CometContextRuleConfiguration
      Parameters:
      contextRulePublication - the context rule publication
    • getContextRuleTargetGroup

      public PluginMethod getContextRuleTargetGroup()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule target group.
      Specified by:
      getContextRuleTargetGroup in interface CometContextRuleConfiguration
      Returns:
      the context rule target group
    • setContextRuleTargetGroup

      public void setContextRuleTargetGroup(PluginMethod contextRuleTargetGroup)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule target group.
      Specified by:
      setContextRuleTargetGroup in interface CometContextRuleConfiguration
      Parameters:
      contextRuleTargetGroup - the context rule target group
    • getContextRuleMarketName

      public PluginMethod getContextRuleMarketName()
      Description copied from interface: CometContextRuleConfiguration
      Gets context rule market name.
      Specified by:
      getContextRuleMarketName in interface CometContextRuleConfiguration
      Returns:
      the context rule market name
    • setContextRuleMarketName

      public void setContextRuleMarketName(PluginMethod contextRuleMarketName)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule market name.
      Specified by:
      setContextRuleMarketName in interface CometContextRuleConfiguration
      Parameters:
      contextRuleMarketName - the context rule market name
    • setContextRuleWell

      public void setContextRuleWell(PluginMethod contextRuleWell)
      Description copied from interface: CometContextRuleConfiguration
      Sets context rule well.
      Specified by:
      setContextRuleWell in interface CometContextRuleConfiguration
      Parameters:
      contextRuleWell - the context rule well
    • setDataProcessingLoad

      public void setDataProcessingLoad(List<PluginMethod> dataProcessingLoad)
      Sets data processing load.
      Parameters:
      dataProcessingLoad - the data processing load
    • setDataProcessingStore

      public void setDataProcessingStore(List<PluginMethod> dataProcessingStore)
      Sets data processing store.
      Parameters:
      dataProcessingStore - the data processing store
    • setDataProvider

      public void setDataProvider(CometPlaceholder.DataProvider dataProvider)
      Sets data provider.
      Parameters:
      dataProvider - the data provider
    • setDescription

      public void setDescription(String description)
      Sets description.
      Parameters:
      description - the description
    • setEntityId

      public void setEntityId(String entityId)
      Sets entity id.
      Parameters:
      entityId - the entity id
    • setLabel

      public void setLabel(String label)
      Sets label.
      Parameters:
      label - the label
    • setLoadConstraint

      public void setLoadConstraint(CometPlaceholder.LoadConstraint loadConstraint)
      Sets load constraint.
      Parameters:
      loadConstraint - the load constraint
    • setLoadId

      public void setLoadId(Integer loadId)
      Sets load id.
      Parameters:
      loadId - the load id
    • setLoadMethod

      public void setLoadMethod(String loadMethod)
      Sets load method.
      Parameters:
      loadMethod - the load method
    • setPostfix

      public void setPostfix(String postfix)
      Sets postfix.
      Parameters:
      postfix - the postfix
    • setPostfixIfEmpty

      public void setPostfixIfEmpty(String postfixIfEmpty)
      Sets postfix if empty.
      Parameters:
      postfixIfEmpty - the postfix if empty
    • setPrefix

      public void setPrefix(String prefix)
      Sets prefix.
      Parameters:
      prefix - the prefix
    • setPrefixIfEmpty

      public void setPrefixIfEmpty(String prefixIfEmpty)
      Sets prefix if empty.
      Parameters:
      prefixIfEmpty - the prefix if empty
    • setStoreAllowed

      public void setStoreAllowed(Boolean storeAllowed)
      Sets store allowed.
      Parameters:
      storeAllowed - the store allowed
    • setStoreId

      public void setStoreId(Integer storeId)
      Sets store id.
      Parameters:
      storeId - the store id
    • setStoreImagePlacement

      public void setStoreImagePlacement(Boolean storeImagePlacement)
      Sets store image placement.
      Parameters:
      storeImagePlacement - the store image placement
    • setStoreMethod

      public void setStoreMethod(String storeMethod)
      Sets store method.
      Parameters:
      storeMethod - the store method
    • setSyncId

      public void setSyncId(Integer syncId)
      Sets sync id.
      Parameters:
      syncId - the sync id
    • setSyncMethod

      public void setSyncMethod(String syncMethod)
      Sets sync method.
      Parameters:
      syncMethod - the sync method
    • setSyncStateVisible

      public void setSyncStateVisible(Boolean syncStateVisible)
      Sets sync state visible and then check it for null and sets it to true if the current value is null.
      Parameters:
      syncStateVisible - the sync state visible
    • setType

      public void setType(CometPlaceholder.PlaceholderType type)
      Sets type.
      Parameters:
      type - the type
    • setUseParent

      public void setUseParent(Boolean useParent)
      Sets use parent.
      Parameters:
      useParent - the use parent
    • setTag

      public void setTag(String tag)
      Sets tag.
      Parameters:
      tag - the tag
    • getCompareScriptId

      public Integer getCompareScriptId()
      Gets compare script id.
      Returns:
      the compare script id
    • setCompareScriptId

      public void setCompareScriptId(Integer compareScriptId)
      Sets compare script id.
      Parameters:
      compareScriptId - the compare script id
    • getCompareScript

      public CometPlaceholderCompareScript getCompareScript()
      Gets compare script.
      Returns:
      the compare script
    • setCompareScript

      public void setCompareScript(CometPlaceholderCompareScript compareScript)
      Sets compare script.
      Parameters:
      compareScript - the compare script
    • getPlaceholderContentTag

      public CometPlaceholder.PlaceholderContentTag getPlaceholderContentTag()
      Gets placeholder content tag.
      Returns:
      the placeholder content tag
    • setPlaceholderContentTag

      public void setPlaceholderContentTag(CometPlaceholder.PlaceholderContentTag placeholderContentTag)
      Sets placeholder content tag.
      Parameters:
      placeholderContentTag - the placeholder content tag
    • getPlaceholderContentQuoteStyle

      public CometPlaceholder.PlaceholderContentQuoteStyle getPlaceholderContentQuoteStyle()
      Gets placeholder content quote style.
      Returns:
      the placeholder content quote style
    • setPlaceholderContentQuoteStyle

      public void setPlaceholderContentQuoteStyle(CometPlaceholder.PlaceholderContentQuoteStyle placeholderContentQuoteStyle)
      Sets placeholder content quote style.
      Parameters:
      placeholderContentQuoteStyle - the placeholder content quote style
    • getCategory

      public CometEntity.Category getCategory()
      Gets category.
      Returns:
      the category
    • setCategory

      public void setCategory(CometEntity.Category category)
      Sets category.
      Parameters:
      category - the category
    • getEntityClass

      public Entity.DataClass getEntityClass()
      Gets entity class.
      Returns:
      the entity class
    • setEntityClass

      public void setEntityClass(Entity.DataClass entityClass)
      Sets entity class.
      Parameters:
      entityClass - the entity class
    • supportsExtendedContextCriteria

      public boolean supportsExtendedContextCriteria()
      Supports extended context criteria boolean.
      Returns:
      the boolean
    • getUseProjectDefault

      public boolean getUseProjectDefault()
      Description copied from interface: CometContextRuleConfiguration
      Gets use project default.
      Specified by:
      getUseProjectDefault in interface CometContextRuleConfiguration
      Returns:
      the use project default
    • setUseProjectDefault

      public void setUseProjectDefault(boolean useProjectDefault)
      Description copied from interface: CometContextRuleConfiguration
      Sets use project default.
      Specified by:
      setUseProjectDefault in interface CometContextRuleConfiguration
      Parameters:
      useProjectDefault - the use project default
    • canUseProjectDefault

      public boolean canUseProjectDefault()
      Description copied from interface: CometContextRuleConfiguration
      Can use project default boolean.
      Specified by:
      canUseProjectDefault in interface CometContextRuleConfiguration
      Returns:
      the boolean
    • getLoadMethodOffline

      public String getLoadMethodOffline()
    • setLoadMethodOffline

      public void setLoadMethodOffline(String loadMethodOffline)
    • getSyncMethodOffline

      public String getSyncMethodOffline()
    • setSyncMethodOffline

      public void setSyncMethodOffline(String syncMethodOffline)
    • getStoreMethodOffline

      public String getStoreMethodOffline()
    • setStoreMethodOffline

      public void setStoreMethodOffline(String storeMethodOffline)
    • processPlaceholderContentTag

      public String processPlaceholderContentTag()
      Process placeholder content tag string.
      Returns:
      the string