Interface StandardDocumentType.StandardFields

  • Enclosing class:
    StandardDocumentType

    public static interface StandardDocumentType.StandardFields
    Reflects the standard fields from a source.
    Since:
    8.1.0
    Version:
    $Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $
    • Field Detail

      • POPULARITY

        static final DocumentTypeField POPULARITY
        Popularity field.
        Since:
        11.1.0
      • INTRODUCTION

        static final DocumentTypeField INTRODUCTION
        Introduction field.
        Since:
        8.1.0
      • INTRODUCTION_IMAGE_FILE_ID

        static final DocumentTypeField INTRODUCTION_IMAGE_FILE_ID
        Introduction image field.
        Since:
        8.1.0
      • INTRODUCTION_IMAGE_HREF

        static final DocumentTypeField INTRODUCTION_IMAGE_HREF
        Introduction image field.
        Since:
        8.1.0
      • PUBLISH_DATE_TIME

        static final DocumentTypeField PUBLISH_DATE_TIME
        Published date time field.
        Since:
        8.1.0
      • CONTEXT_IDS

        static final DocumentTypeField CONTEXT_IDS
        Context identifiers field. The values of this field specifies the contexts that this document belongs to. When a document belongs to a context, its lifecycle is managed by that context.

        For example, if a document belongs to a context that is a service instance, when the service instance is removed the document will be removed. When the service instance is re-indexed, the document will be re-indexed (updated from its original source).

        Since:
        8.1.0
      • PUBLICATIONS

        static final CompositeDocumentTypeField PUBLICATIONS
        Publications field. Each value included in this field corresponds a publication of the document. Each publication defines list of contexts (each context has its URL for viewing it) where information about this document may be viewed. Each publication also defines the group of principals that may view it.
        Since:
        8.1.0
      • PUBLICATIONS_PRINCIPAL_IDS

        static final DocumentTypeField PUBLICATIONS_PRINCIPAL_IDS
        Principal identifiers field from a publications field. This field specifies that the corresponding publication should be made available only to users that are in this principal list, or belong to a group in this principal list.
        Since:
        8.1.0
        See Also:
        PUBLICATIONS
      • PUBLICATIONS_CONTEXTS

        static final CompositeDocumentTypeField PUBLICATIONS_CONTEXTS
        Contexts field from a publications field. Each value in this field is a context where the publication is available to be viewed.

        For example, there are news service instances A and B. A news content is added to service instance A and published to both A and B. In this case, the content belongs to context A and has publication contexts for both A and B. The publication context for A has a URL for that content on a page with a details interface of service instance A, and the publication context for B has a URL for that content on a page with a details interface of service instance B.

        Since:
        8.1.0
        See Also:
        PUBLICATIONS
      • SERVICE_ID

        static final DocumentTypeField SERVICE_ID
        Service identifier field.
        Since:
        8.1.0
      • ITEM_ID

        static final DocumentTypeField ITEM_ID
        Item identifier field.
        Since:
        8.1.0
      • SERVICE_INSTANCE_ID

        static final DocumentTypeField SERVICE_INSTANCE_ID
        Service instance identifier field.
        Since:
        8.1.0
      • DEFAULT_LOCALE

        static final DocumentTypeField DEFAULT_LOCALE
        Default locale field.
        Since:
        8.1.0
      • OTHER_LOCALES

        static final DocumentTypeField OTHER_LOCALES
        Other locales field.
        Since:
        8.1.0
      • DIRECT_CATEGORIES

        static final CompositeDocumentTypeField DIRECT_CATEGORIES
        Field that corresponds to the content's direct categories.
        Since:
        9.0.0
      • DIRECT_CATEGORIES_ID

        static final DocumentTypeField DIRECT_CATEGORIES_ID
        Field that corresponds to the content's direct categories' id.
        Since:
        9.0.0
      • DIRECT_CATEGORIES_NAME

        static final DocumentTypeField DIRECT_CATEGORIES_NAME
        Field that corresponds to the content's direct categories' name.
        Since:
        9.0.0
      • FULL_CATEGORIES

        static final CompositeDocumentTypeField FULL_CATEGORIES
        Field that corresponds to the content's inherited categories.
        Since:
        9.0.0
      • FULL_CATEGORIES_ID

        static final DocumentTypeField FULL_CATEGORIES_ID
        Field that corresponds to the content's inherited categories' id.
        Since:
        9.0.0
      • FULL_CATEGORIES_NAME

        static final DocumentTypeField FULL_CATEGORIES_NAME
        Field that corresponds to the content's inherited categories' name.
        Since:
        9.0.0
      • TAG_NORMALIZED_NAME

        static final DocumentTypeField TAG_NORMALIZED_NAME
        Field that corresponds to a content's tag normalized name.
        Since:
        9.0.0
      • TAG_NAME

        static final DocumentTypeField TAG_NAME
        Field that corresponds to a content's tag name.
        Since:
        9.0.0
      • TAG_ANALYZED_NAME

        static final DocumentTypeField TAG_ANALYZED_NAME
        Field that corresponds to a content's analyzed tag name.
        Since:
        9.0.0