Package lumis.content.bigdata

Interface ContentVersionDocument.ContentVersion

Enclosing class:

ContentVersionDocument

public static interface ContentVersionDocument.ContentVersion

API that provides access to content version fields.

Since:

8.1.0

Version:

$Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

Method Summary

Modifier and Type	Method	Description
ContentVersionDocument.ContentVersionPublication	addPublication()	Adds a new publication in this document.
String	getCanonicalUrl()	Returns the value of ContentVersionDocumentType.ContentVersionFields.CANONICAL_URL stored in this document.
ContentVersionDocument.ContentLocale	getContentLocale()	Returns the value of ContentVersionDocumentType.ContentVersionFields.CONTENT_LOCALE stored in this document.
String	getId()	Returns the value of ContentVersionDocumentType.ContentVersionFields.ID stored in this document.
String	getIntroduction()	Returns the value of ContentVersionDocumentType.ContentVersionFields.INTRODUCTION stored in this document.
String	getItemId()	Returns the value of ContentVersionDocumentType.ContentVersionFields.ITEM_ID stored in this document.
String	getLastModifiedBy()	Returns the value of ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_BY stored in this document.
Date	getLastModifiedDateTime()	Returns the value of ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_DATE_TIME stored in this document.
String	getPageSimpleTitle()	Returns the value of ContentVersionDocumentType.ContentVersionFields.PAGE_SIMPLE_TITLE stored in this document.
String	getPrimaryName()	Returns the value of ContentVersionDocumentType.ContentVersionFields.PRIMARY_NAME stored in this document.
List<ContentVersionDocument.ContentVersionPublication>	getPublications()	Returns the access to the fields belonging to the publications fields in this document.
String	getSeoDescription()	Returns the value of ContentVersionDocumentType.ContentVersionFields.SEO_DESCRIPTION stored in this document.
String	getSocialDescription()	Returns the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_DESCRIPTION stored in this document.
String	getSocialImageMediaId()	Returns the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_IMAGE_MEDIA_ID stored in this document.
String	getSocialTitle()	Returns the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_TITLE stored in this document.
String	getUrlPath()	Returns the value of ContentVersionDocumentType.ContentVersionFields.URL_PATH stored in this document.
String	getUrlTitle()	Returns the value of ContentVersionDocumentType.ContentVersionFields.URL_TITLE stored in this document.
int	getVersionNumber()	Returns the value of ContentVersionDocumentType.ContentVersionFields.VERSION_NUMBER stored in this document.
boolean	isActiveVersion()	Returns the boolean value of ContentVersionDocumentType.ContentVersionFields.ACTIVE_VERSION stored in this document.
boolean	isPublishedVersion()	Returns the value of ContentVersionDocumentType.ContentVersionFields.PUBLISHED_VERSION stored in this document.
void	setActiveVersion(boolean activeVersion)	Sets the value for ContentVersionDocumentType.ContentVersionFields.ACTIVE_VERSION in this document.
void	setCanonicalUrl(String canonicalUrl)	Sets the value of ContentVersionDocumentType.ContentVersionFields.CANONICAL_URL stored in this document.
void	setId(String contentVersionId)	Sets the value for ContentVersionDocumentType.ContentVersionFields.ID in this document.
void	setIntroduction(String contentVersionIntroduction)	Sets the value for ContentVersionDocumentType.ContentVersionFields.INTRODUCTION in this document.
void	setItemId(String itemId)	Sets the value for ContentVersionDocumentType.ContentVersionFields.ITEM_ID in this document.
void	setLastModifiedBy(String lastModifiedBy)	Sets the value for ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_BY in this document.
void	setLastModifiedDateTime(Date lastModifiedDateTime)	Sets the value for ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_DATE_TIME in this document.
void	setPageSimpleTitle(String title)	Sets the value of ContentVersionDocumentType.ContentVersionFields.PAGE_SIMPLE_TITLE stored in this document.
void	setPrimaryName(String primaryName)	Sets the value for ContentVersionDocumentType.ContentVersionFields.PRIMARY_NAME in this document.
void	setPublishedVersion(boolean publishedVersion)	Sets the value for ContentVersionDocumentType.ContentVersionFields.PUBLISHED_VERSION in this document.
void	setSeoDescription(String description)	Sets the value of ContentVersionDocumentType.ContentVersionFields.SEO_DESCRIPTION stored in this document.
void	setSocialDescription(String description)	Sets the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_DESCRIPTION stored in this document.
void	setSocialImageMediaId(String mediaId)	Sets the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_IMAGE_MEDIA_ID stored in this document.
void	setSocialTitle(String title)	Sets the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_TITLE stored in this document.
void	setUrlPath(String path)	Sets the value of ContentVersionDocumentType.ContentVersionFields.URL_PATH stored in this document.
void	setUrlTitle(String title)	Sets the value of ContentVersionDocumentType.ContentVersionFields.URL_TITLE stored in this document.
void	setVersionNumber(int versionNumber)	Sets the value for ContentVersionDocumentType.ContentVersionFields.VERSION_NUMBER in this document.

Method Detail

getId

String getId()

Returns the value of ContentVersionDocumentType.ContentVersionFields.ID stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.ID.

Since:

8.1.0

See Also:

ContentVersion.getId()

setId

void setId(String contentVersionId)

Sets the value for ContentVersionDocumentType.ContentVersionFields.ID in this document.

Parameters:

contentVersionId - the content version identifier to set.

Since:

8.1.0

getItemId

String getItemId()

Returns the value of ContentVersionDocumentType.ContentVersionFields.ITEM_ID stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.ITEM_ID.

Since:

8.1.0

See Also:

ContentVersion.getItemId()

setItemId

void setItemId(String itemId)

Sets the value for ContentVersionDocumentType.ContentVersionFields.ITEM_ID in this document.

Parameters:

itemId - the item identifier to set.

Since:

8.1.0

See Also:

ContentVersion.setItemId(String)

isPublishedVersion

boolean isPublishedVersion()

Returns the value of ContentVersionDocumentType.ContentVersionFields.PUBLISHED_VERSION stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.PUBLISHED_VERSION.

Since:

8.1.0

See Also:

ContentVersion.getPublishedVersion()

setPublishedVersion

void setPublishedVersion(boolean publishedVersion)

Sets the value for ContentVersionDocumentType.ContentVersionFields.PUBLISHED_VERSION in this document.

Parameters:

publishedVersion - the value to set.

Since:

8.1.0

isActiveVersion

boolean isActiveVersion()

Returns the boolean value of ContentVersionDocumentType.ContentVersionFields.ACTIVE_VERSION stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.ACTIVE_VERSION.

Since:

8.1.0

See Also:

ContentLocale.addVersion(), ContentLocale.getActiveVersion()

setActiveVersion

void setActiveVersion(boolean activeVersion)

Sets the value for ContentVersionDocumentType.ContentVersionFields.ACTIVE_VERSION in this document.

Parameters:

activeVersion - the value to set.

Since:

8.1.0

See Also:

ContentLocale.addVersion(), ContentLocale.getActiveVersion()

getLastModifiedBy

String getLastModifiedBy()

Returns the value of ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_BY stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_BY.

Since:

8.1.0

See Also:

ContentVersion.getLastModifiedBy()

setLastModifiedBy

void setLastModifiedBy(String lastModifiedBy)

Sets the value for ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_BY in this document.

Parameters:

lastModifiedBy - the value to set.

Since:

8.1.0

See Also:

ContentVersion.setLastModifiedBy(String)

getLastModifiedDateTime

Date getLastModifiedDateTime()

Returns the value of ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_DATE_TIME stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_DATE_TIME.

Since:

8.1.0

See Also:

ContentVersion.getLastModifiedDateTime()

setLastModifiedDateTime

void setLastModifiedDateTime(Date lastModifiedDateTime)

Sets the value for ContentVersionDocumentType.ContentVersionFields.LAST_MODIFIED_DATE_TIME in this document.

Parameters:

lastModifiedDateTime - the last modified date time to set.

Since:

8.1.0

See Also:

ContentVersion.setLastModifiedDateTime(Date)

getPrimaryName

String getPrimaryName()

Returns the value of ContentVersionDocumentType.ContentVersionFields.PRIMARY_NAME stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.PRIMARY_NAME.

Since:

8.1.0

See Also:

ContentVersion.getPrimaryName()

setPrimaryName

void setPrimaryName(String primaryName)

Sets the value for ContentVersionDocumentType.ContentVersionFields.PRIMARY_NAME in this document.

Parameters:

primaryName - the primary name value to set.

Since:

8.1.0

See Also:

ContentVersion.setPrimaryName(String)

getVersionNumber

int getVersionNumber()

Returns the value of ContentVersionDocumentType.ContentVersionFields.VERSION_NUMBER stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.VERSION_NUMBER.

Since:

8.1.0

See Also:

ContentVersion.getVersionNumber()

setVersionNumber

void setVersionNumber(int versionNumber)

Sets the value for ContentVersionDocumentType.ContentVersionFields.VERSION_NUMBER in this document.

Parameters:

contentVersionVersionNumber - the version number to set.

Since:

8.1.0

See Also:

ContentVersion.getVersionNumber()

getIntroduction

String getIntroduction()

Returns the value of ContentVersionDocumentType.ContentVersionFields.INTRODUCTION stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.INTRODUCTION.

Since:

8.1.0

See Also:

ContentVersion.getIntroduction(), ContentLocale.addVersion()

setIntroduction

void setIntroduction(String contentVersionIntroduction)

Sets the value for ContentVersionDocumentType.ContentVersionFields.INTRODUCTION in this document.

Parameters:

contentVersionIntroduction - the content version introduction value to set.

Since:

8.1.0

See Also:

ContentVersion.setIntroduction(String)

getPageSimpleTitle

String getPageSimpleTitle()

Returns the value of ContentVersionDocumentType.ContentVersionFields.PAGE_SIMPLE_TITLE stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.PAGE_SIMPLE_TITLE.

Since:

10.2.0

See Also:

ContentVersion.getPageSimpleTitle()

setPageSimpleTitle

void setPageSimpleTitle(String title)

Sets the value of ContentVersionDocumentType.ContentVersionFields.PAGE_SIMPLE_TITLE stored in this document.

Parameters:

title - the simple title value to set.

Since:

10.2.0

See Also:

ContentVersion.setPageSimpleTitle(String)

getCanonicalUrl

String getCanonicalUrl()

Returns the value of ContentVersionDocumentType.ContentVersionFields.CANONICAL_URL stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.CANONICAL_URL.

Since:

10.1.0

See Also:

ContentVersion.getCanonicalUrl()

setCanonicalUrl

void setCanonicalUrl(String canonicalUrl)

Sets the value of ContentVersionDocumentType.ContentVersionFields.CANONICAL_URL stored in this document.

Parameters:

canonicalUrl - the canonicalUrl value to set.

Since:

10.1.0

See Also:

ContentVersion.setCanonicalUrl(URL)

getUrlTitle

String getUrlTitle()

Returns the value of ContentVersionDocumentType.ContentVersionFields.URL_TITLE stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.URL_TITLE.

Since:

10.0.0

See Also:

ContentVersion.getUrlTitle()

setUrlTitle

void setUrlTitle(String title)

Sets the value of ContentVersionDocumentType.ContentVersionFields.URL_TITLE stored in this document.

Parameters:

title - the title value to set.

Since:

10.0.0

See Also:

ContentVersion.setUrlTitle(String)

getUrlPath

String getUrlPath()

Returns the value of ContentVersionDocumentType.ContentVersionFields.URL_PATH stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.URL_PATH.

Since:

12.5.0

See Also:

ContentVersion.getUrlPath()

setUrlPath

void setUrlPath(String path)

Sets the value of ContentVersionDocumentType.ContentVersionFields.URL_PATH stored in this document.

Parameters:

path - the path value to set.

Since:

12.5.0

See Also:

ContentVersion.setUrlPath(String)

getSeoDescription

String getSeoDescription()

Returns the value of ContentVersionDocumentType.ContentVersionFields.SEO_DESCRIPTION stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.SEO_DESCRIPTION.

Since:

10.0.0

See Also:

ContentVersion.getSeoDescription()

setSeoDescription

void setSeoDescription(String description)

Sets the value of ContentVersionDocumentType.ContentVersionFields.SEO_DESCRIPTION stored in this document.

Parameters:

description - the description value to set.

Since:

10.0.0

See Also:

ContentVersion.setSeoDescription(String)

getSocialTitle

String getSocialTitle()

Returns the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_TITLE stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_TITLE.

Since:

10.0.0

See Also:

ContentVersion.getSocialTitle()

setSocialTitle

void setSocialTitle(String title)

Sets the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_TITLE stored in this document.

Parameters:

title - the title value to set.

Since:

10.0.0

See Also:

ContentVersion.setSocialTitle(String)

getSocialDescription

String getSocialDescription()

Returns the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_DESCRIPTION stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_DESCRIPTION.

Since:

10.0.0

See Also:

ContentVersion.getSocialDescription()

setSocialDescription

void setSocialDescription(String description)

Sets the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_DESCRIPTION stored in this document.

Parameters:

description - the description value to set.

Since:

10.0.0

See Also:

ContentVersion.setSocialDescription(String)

getSocialImageMediaId

String getSocialImageMediaId()

Returns the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_IMAGE_MEDIA_ID stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_IMAGE_MEDIA_ID.

Since:

10.0.0

See Also:

ContentVersion.getSocialImageFileId()

setSocialImageMediaId

void setSocialImageMediaId(String mediaId)

Sets the value of ContentVersionDocumentType.ContentVersionFields.SOCIAL_IMAGE_MEDIA_ID stored in this document.

Parameters:

mediaId - the media identifier.

Since:

10.0.0

See Also:

ContentVersion.setSocialImageMediaId(String)

getPublications

List<ContentVersionDocument.ContentVersionPublication> getPublications()

Returns the access to the fields belonging to the 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.

Returns:

the access to the fields belonging to the publications fields in this document.

Since:

8.1.0

See Also:

ContentVersion.getPublications()

addPublication

ContentVersionDocument.ContentVersionPublication addPublication()

Adds a new publication in this document.

Returns:

the added publication.

Since:

8.1.0

getContentLocale

ContentVersionDocument.ContentLocale getContentLocale()

Returns the value of ContentVersionDocumentType.ContentVersionFields.CONTENT_LOCALE stored in this document.

Returns:

the value of ContentVersionDocumentType.ContentVersionFields.CONTENT_LOCALE.

Since:

8.1.0

See Also:

ContentVersion.getContentLocale()