Package lumis.portal.ai.bigdata

Interface KnowledgeStandardDocument.Knowledge

  • Enclosing class:
    KnowledgeStandardDocument
    public static interface KnowledgeStandardDocument.Knowledge
    API that provides access to standard fields.
    Since:
    16.1.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addContextIds​(java.lang.String... contextIds)
      Adds the given context identifiers in this document.
      void addContextIds​(java.util.Collection<java.lang.String> contextIds)
      Adds the given context identifiers in this document.
      void addOtherLocales​(java.lang.String... otherLocales)
      Adds other locales of this document.
      void addOtherLocales​(java.util.Collection<java.lang.String> otherLocales)
      Adds other locales of this document.
      KnowledgeStandardDocument.Knowledge.Publication addPublication()
      Adds a new publications field in this document.
      java.lang.String getContentId()
      Returns the content identifier present in this document.
      java.util.List<java.lang.String> getContextIds()
      Returns the context identifiers present in this document.
      java.lang.String getData()
      Returns the item identifier present in this document.
      java.lang.String getItemId()
      Returns the item identifier present in this document.
      java.lang.String getLocale()
      Returns this document locale.
      java.util.Collection<java.lang.String> getOtherLocales()
      Returns the other locales of this document.
      java.util.List<KnowledgeStandardDocument.Knowledge.Publication> getPublications()
      Returns the access to the fields belonging to the publications fields in this document.
      java.util.Date getPublishDateTime()
      Returns the publish date time in this document.
      java.lang.String getServiceId()
      Returns the service identifier present in this document.
      java.lang.String getServiceInstanceId()
      Returns the service instance identifier present in this document.
      java.lang.String getSourceId()
      Returns this document sourceId.
      java.lang.Boolean isDefaultLocale()
      Returns whether this document is the default document for missing locales.
      void setContentId​(java.lang.String contentId)
      Sets the given content identifier in this document.
      void setData​(java.lang.String data)
      Sets the given data in this document.
      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.
      void setItemId​(java.lang.String itemId)
      Sets the given item identifier in this document.
      void setLocale​(java.lang.String locale)
      Sets the locale.
      void setPublishDateTime​(java.util.Date publishDateTime)
      Sets the publish date time in this document.
      void setServiceId​(java.lang.String serviceId)
      Sets the given service identifier in this document.
      void setServiceInstanceId​(java.lang.String serviceInstanceId)
      Sets the service instance identifier in this document.
      void setSourceId​(java.lang.String sourceId)
      Sets the sourceId.

    • 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:
        16.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:
        16.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:
        16.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:
        16.1.0
        See Also:
        StandardDocumentType.StandardFields.SERVICE_INSTANCE_ID

      • 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:
        16.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:
        16.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:
        16.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:
        16.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:
        16.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:
        16.1.0
        See Also:
        StandardDocumentType.StandardFields.ITEM_ID

      • setContentId

        void setContentId​(java.lang.String contentId)
        Sets the given content identifier in this document.
        Parameters:
        contentId - the content identifier to set.
        Since:
        16.1.0

      • getContentId

        java.lang.String getContentId()
        Returns the content identifier present in this document.
        Returns:
        the content identifier present in this document.
        Since:
        16.1.0

      • setData

        void setData​(java.lang.String data)
        Sets the given data in this document.
        Parameters:
        data - the data to set.
        Since:
        16.1.0

      • getData

        java.lang.String getData()
        Returns the item identifier present in this document.
        Returns:
        the item identifier present in this document.
        Since:
        16.1.0

      • setLocale

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

      • getLocale

        java.lang.String getLocale()
        Returns this document locale.
        Returns:
        this document locale.
        Since:
        16.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:
        16.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:
        16.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:
        16.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:
        16.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:
        16.1.0

      • setSourceId

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

      • getSourceId

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