Package lumis.portal.bigdata

Interface StandardDocument.Standard

  • Enclosing class:
    StandardDocument
    @StableMinor(version="16.1",
             sinceVersion="8.1")
public static interface StandardDocument.Standard
    API that provides access to standard fields.
    Since:
    8.1.0
    Version:
    $Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

    • Method Detail

      • setServiceId

        void setServiceId​(java.lang.String serviceId)
        Sets the given service identifier in this document.
        Parameters:
        serviceId - the service identifier to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.SERVICE_ID

      • getServiceId

        java.lang.String getServiceId()
        Returns the service identifier present in this document.
        Returns:
        the service identifier present in this document.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.SERVICE_ID

      • setServiceInstanceId

        void setServiceInstanceId​(java.lang.String serviceInstanceId)
        Sets the service instance identifier in this document.
        Parameters:
        serviceInstanceId - the service instance identifier to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.SERVICE_INSTANCE_ID

      • getServiceInstanceId

        java.lang.String getServiceInstanceId()
        Returns the service instance identifier present in this document.
        Returns:
        the service instance identifier present in this document.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.SERVICE_INSTANCE_ID

      • setIntroduction

        void setIntroduction​(java.lang.String introduction)
        Sets the given introduction in this document.
        Parameters:
        introduction - the introduction value to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.INTRODUCTION

      • setIntroductionImageFileId

        void setIntroductionImageFileId​(java.lang.String introductionImageFileId)
        Sets the file identifier corresponding to the introduction image in this document.
        Parameters:
        introductionImageFileId - the introduction image file identifier to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_FILE_ID

      • getIntroductionImageFileId

        java.lang.String getIntroductionImageFileId()
        Returns the file identifier of the introduction image present in this document.
        Returns:
        the file identifier of the introduction image present in this document.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_FILE_ID

      • setIntroductionImageHref

        void setIntroductionImageHref​(java.lang.String introductionImageHref)
        Sets the href (absolute or relative to portal root) corresponding to the introduction image in this document.
        Parameters:
        introductionImageHref - the introduction image href value to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_HREF

      • getIntroductionImageHref

        java.lang.String getIntroductionImageHref()
        Returns the href (absolute or relative to portal root) of the introduction image present in this document.
        Returns:
        the href (absolute or relative to portal root) of the introduction image present in this document.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_HREF

      • setPublishDateTime

        void setPublishDateTime​(java.util.Date publishDateTime)
        Sets the publish date time in this document.
        Parameters:
        publishDateTime - the publish date time value to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.PUBLISH_DATE_TIME

      • addContextIds

        void addContextIds​(java.util.Collection<java.lang.String> contextIds)
        Adds the given context identifiers in this document.
        Parameters:
        contextIds - the context identifiers to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.CONTEXT_IDS

      • addContextIds

        void addContextIds​(java.lang.String... contextIds)
        Adds the given context identifiers in this document.
        Parameters:
        contextIds - the context identifiers to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.CONTEXT_IDS

      • getContextIds

        java.util.List<java.lang.String> getContextIds()
        Returns the context identifiers present in this document.
        Returns:
        the context identifiers present in this document.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.CONTEXT_IDS

      • setItemId

        void setItemId​(java.lang.String itemId)
        Sets the given item identifier in this document.
        Parameters:
        itemId - the item identifier to set.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.ITEM_ID

      • getItemId

        java.lang.String getItemId()
        Returns the item identifier present in this document.
        Returns:
        the item identifier present in this document.
        Since:
        8.1.0
        See Also:
        StandardDocumentType.StandardFields.ITEM_ID

      • setLocale

        void setLocale​(java.lang.String locale)
        Sets the locale.
        Parameters:
        locale - the locale.
        Since:
        8.1.0

      • getLocale

        java.lang.String getLocale()
        Returns this document locale.
        Returns:
        this document locale.
        Since:
        8.1.0

      • setDefaultLocale

        void setDefaultLocale​(java.lang.Boolean isDefault)
        Sets whether this document is the default document for missing locales.
        This means this document should be used when no other equivalent document exist for a given search or filter.
        Parameters:
        isDefault - whether this document is the default document for missing locales.
        Since:
        8.1.0

      • isDefaultLocale

        java.lang.Boolean isDefaultLocale()
        Returns whether this document is the default document for missing locales.
        Returns:
        whether this document is the default document for missing locales.
        Since:
        8.1.0
        See Also:
        setDefaultLocale(Boolean)

      • addOtherLocales

        void addOtherLocales​(java.lang.String... otherLocales)
        Adds other locales of this document. These are the other languages this document is also available in.
        Parameters:
        otherLocales - the other locales of this document.
        Since:
        8.1.0

      • addOtherLocales

        void addOtherLocales​(java.util.Collection<java.lang.String> otherLocales)
        Adds other locales of this document. These are the other languages this document is also available in.
        Parameters:
        otherLocales - the other locales of this document.
        Since:
        8.1.0

      • getOtherLocales

        java.util.Collection<java.lang.String> getOtherLocales()
        Returns the other locales of this document.
        Returns:
        the other locales of this document.
        Since:
        8.1.0

      • getTags

        java.util.List<StandardDocument.Standard.Tag> getTags()
        Returns the tag list present in this content locale.
        Returns:
        the tag list present in this content locale.
        Since:
        9.0.0

      • addTag

        StandardDocument.Standard.Tag addTag()
        Adds a tag in the tag list of this content locale and returns it.
        Returns:
        the created tag.
        Since:
        9.0.0

      • setPopularity

        void setPopularity​(java.lang.Double popularity)
        Sets the popularity.
        Parameters:
        popularity - the popularity.
        Since:
        11.1.0

      • getPopularity

        java.lang.Double getPopularity()
        Returns this document popularity.
        Returns:
        this document popularity.
        Since:
        11.1.0

      • setSourceId

        void setSourceId​(java.lang.String sourceId)
        Sets the sourceId.
        Parameters:
        sourceId - the sourceId.
        Since:
        11.1.0

      • getSourceId

        java.lang.String getSourceId()
        Returns this document sourceId.
        Returns:
        this document sourceId.
        Since:
        11.1.0

      • setSlug

        void setSlug​(java.lang.String slug)
        Sets the slug.
        Parameters:
        slug -
        Since:
        14.2.0

      • getSlug

        java.lang.String getSlug()
        Returns the slug in this document.
        Returns:
        the slug in this document.
        Since:
        14.2.0