@StableMinor(version="12.3", sinceVersion="8.1") public static interface StandardDocument.Standard
Modifier and Type | Interface and Description |
---|---|
static interface |
StandardDocument.Standard.Categories
API that provides access to categorization fields.
|
static interface |
StandardDocument.Standard.Publication
API that provides access to publications fields.
|
static interface |
StandardDocument.Standard.Tag
Represents a content tag.
|
Modifier and Type | Method and Description |
---|---|
void |
addContextIds(Collection<String> contextIds)
Adds the given context identifiers in this document.
|
void |
addContextIds(String... contextIds)
Adds the given context identifiers in this document.
|
void |
addOtherLocales(Collection<String> otherLocales)
Adds other locales of this document.
|
void |
addOtherLocales(String... otherLocales)
Adds other locales of this document.
|
StandardDocument.Standard.Publication |
addPublication()
Adds a new publications field in this document.
|
StandardDocument.Standard.Tag |
addTag()
Adds a tag in the tag list of this content locale and returns it.
|
StandardDocument.Standard.Categories |
getCategories()
Returns the value of
StandardDocumentType.StandardFields.CATEGORIES stored in this document. |
List<String> |
getContextIds()
Returns the context identifiers present in this document.
|
String |
getIntroduction()
Returns the introduction present in this document.
|
String |
getIntroductionImageFileId()
Returns the file identifier of the introduction image present in this document.
|
String |
getIntroductionImageHref()
Returns the href (absolute or relative to portal root) of the introduction image present in this document.
|
String |
getItemId()
Returns the item identifier present in this document.
|
String |
getLocale()
Returns this document locale.
|
Collection<String> |
getOtherLocales()
Returns the other locales of this document.
|
Double |
getPopularity()
Returns this document popularity.
|
List<StandardDocument.Standard.Publication> |
getPublications()
Returns the access to the fields belonging to the
publications fields in
this document. |
Date |
getPublishDateTime()
Returns the publish date time in this document.
|
String |
getServiceId()
Returns the service identifier present in this document.
|
String |
getServiceInstanceId()
Returns the service instance identifier present in this document.
|
String |
getSourceId()
Returns this document sourceId.
|
List<StandardDocument.Standard.Tag> |
getTags()
Returns the tag list present in this content locale.
|
String |
getTitle()
Returns the title present in this document.
|
Boolean |
isDefaultLocale()
Returns whether this document is the default document for missing locales.
|
void |
setDefaultLocale(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 |
setIntroduction(String introduction)
Sets the given introduction in this document.
|
void |
setIntroductionImageFileId(String introductionImageFileId)
Sets the file identifier corresponding to the introduction image in this document.
|
void |
setIntroductionImageHref(String introductionImageHref)
Sets the href (absolute or relative to portal root) corresponding to the introduction image in this document.
|
void |
setItemId(String itemId)
Sets the given item identifier in this document.
|
void |
setLocale(String locale)
Sets the locale.
|
void |
setPopularity(Double popularity)
Sets the popularity.
|
void |
setPublishDateTime(Date publishDateTime)
Sets the publish date time in this document.
|
void |
setServiceId(String serviceId)
Sets the given service identifier in this document.
|
void |
setServiceInstanceId(String serviceInstanceId)
Sets the service instance identifier in this document.
|
void |
setSourceId(String sourceId)
Sets the sourceId.
|
void |
setTitle(String title)
Sets the given title in this document.
|
void setServiceId(String serviceId)
serviceId
- the service identifier to set.StandardDocumentType.StandardFields.SERVICE_ID
String getServiceId()
StandardDocumentType.StandardFields.SERVICE_ID
void setServiceInstanceId(String serviceInstanceId)
serviceInstanceId
- the service instance identifier to set.StandardDocumentType.StandardFields.SERVICE_INSTANCE_ID
String getServiceInstanceId()
StandardDocumentType.StandardFields.SERVICE_INSTANCE_ID
void setTitle(String title)
title
- the title value to set.StandardDocumentType.StandardFields.TITLE
String getTitle()
StandardDocumentType.StandardFields.TITLE
void setIntroduction(String introduction)
introduction
- the introduction value to set.StandardDocumentType.StandardFields.INTRODUCTION
String getIntroduction()
StandardDocumentType.StandardFields.INTRODUCTION
void setIntroductionImageFileId(String introductionImageFileId)
introductionImageFileId
- the introduction image file identifier to set.StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_FILE_ID
String getIntroductionImageFileId()
StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_FILE_ID
void setIntroductionImageHref(String introductionImageHref)
introductionImageHref
- the introduction image href value to set.StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_HREF
String getIntroductionImageHref()
StandardDocumentType.StandardFields.INTRODUCTION_IMAGE_HREF
void setPublishDateTime(Date publishDateTime)
publishDateTime
- the publish date time value to set.StandardDocumentType.StandardFields.PUBLISH_DATE_TIME
Date getPublishDateTime()
StandardDocumentType.StandardFields.PUBLISH_DATE_TIME
void addContextIds(Collection<String> contextIds)
contextIds
- the context identifiers to set.StandardDocumentType.StandardFields.CONTEXT_IDS
void addContextIds(String... contextIds)
contextIds
- the context identifiers to set.StandardDocumentType.StandardFields.CONTEXT_IDS
List<String> getContextIds()
StandardDocumentType.StandardFields.CONTEXT_IDS
StandardDocument.Standard.Publication addPublication()
StandardDocumentType.StandardFields.PUBLICATIONS
List<StandardDocument.Standard.Publication> getPublications()
publications
fields in
this document.
The returned list does not support the set method and its remove method always return null
, even when
it removes a value.
StandardDocumentType.StandardFields.PUBLICATIONS
void setItemId(String itemId)
itemId
- the item identifier to set.StandardDocumentType.StandardFields.ITEM_ID
String getItemId()
StandardDocumentType.StandardFields.ITEM_ID
void setLocale(String locale)
locale
- the locale.String getLocale()
void setDefaultLocale(Boolean isDefault)
isDefault
- whether this document is the default document for missing locales.Boolean isDefaultLocale()
setDefaultLocale(Boolean)
void addOtherLocales(String... otherLocales)
otherLocales
- the other locales of this document.void addOtherLocales(Collection<String> otherLocales)
otherLocales
- the other locales of this document.Collection<String> getOtherLocales()
StandardDocument.Standard.Categories getCategories()
StandardDocumentType.StandardFields.CATEGORIES
stored in this document.StandardDocumentType.StandardFields.CATEGORIES
stored in this document.ContentVersion.getContentAssociations()
List<StandardDocument.Standard.Tag> getTags()
StandardDocument.Standard.Tag addTag()
void setPopularity(Double popularity)
popularity
- the popularity.Double getPopularity()
void setSourceId(String sourceId)
sourceId
- the sourceId.String getSourceId()
LumisXP 12.3.0.200408 - Copyright © 2006–2020 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.