Package com.priint.pubserver.comet.bridge.preview

Annotation Type CometPreviewResultProperties

  • @Inherited
@Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface CometPreviewResultProperties

    The CometPreviewResultProperties annotation defines properties to set for preview statement results when using the standard mapping.

    The standard mapping is used, when no other mapping or processing instructions are defined via a CometPreviewProcessingProperties annotation.

    For examples please refer to the DemoPreviewStatement Plugin delivered with the PublishingServer developer stack.

    • Element Detail

      • linkScriptLabel

        java.lang.String linkScriptLabel

        The label of a CometPreviewLinkScript.

        When using standard mappings for the results of a preview method call, the ID of this script is used for all result objects.
        If a script with this label does not exist or isn't a CometPreviewLinkScript, an exception will be raised.

        Returns:
        label of a CometPreviewLinkScript
        Default:
        ""

      • linkScriptId

        int linkScriptId

        ID of a CometPreviewLinkScript.

        When using standard mapping for the results of a preview method call, the ID of this script is used for all result objects.

        Returns:
        ID of a CometPreviewLinkScript
        Default:
        0

      • useMediaProxy

        boolean useMediaProxy

        Use proxy for MediaAsset data.

        If set to true, media preview and data will be requested from PubServer. This requires, that the media files are accessible in the server file system.
        Default is true, i.e.: use proxy.

        Returns:
        true, if proxy should be used, false otherwise.
        Default:
        true

      • priceProperty

        CometPreviewResultProperties.PriceProperty priceProperty

        Use this price property for result content

        When using standard mapping, this price property will be set as the content for result objects of type Price

        Returns:
        name of the property to use, default is LISTPRICE
        Default:
        com.priint.pubserver.comet.bridge.preview.CometPreviewResultProperties.PriceProperty.LISTPRICE