com.adobe.cq.social.filelibrary.client.api

Interface Asset<T extends CommentCollectionConfiguration>

All Superinterfaces:

Comment<T>, SocialCollectionComponent, SocialComponent

All Known Subinterfaces:

Document

All Known Implementing Classes:

AbstractAsset

public interface Asset<T extends CommentCollectionConfiguration>
extends Comment<T>

An Asset represents a document or a folder in a FileLibrary. A folder can only contain sub-folders or documents. A document is represented as an attachment of a comment. An asset is represented as a comment, or a reply of a comment, depending on the level of the asset relative to its parents.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.commons.comments.api.Comment

Comment.ModeratorActions, Comment.ModeratorStatus, Comment.Tag

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LAST_SELF_MOD_BY JCR properties that maintains the id of the user that effected the last modification of this topic.
static java.lang.String	PN_NAME

Fields inherited from interface com.adobe.cq.social.commons.comments.api.Comment

COMMENT_RESOURCETYPE, COMMENTCOLLECTION_RESOURCETYPE, JSON_EXTENSION, NODE_TYPE, PROP_APPROVED, PROP_REFERER, PROP_SPAM, PROP_USE_REFERRER_URL, SOCO_SELECTOR

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileLibraryId() Get the FileLibrary id for this asset.
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
java.lang.String	getName() Get the name of the asset
java.lang.String	getParentFriendlyUrl()
java.lang.String	getParentName()
boolean	isFileLibraryClosed()
boolean	isFolder() Check if this instance is a folder or a document.

Methods inherited from interface com.adobe.cq.social.commons.comments.api.Comment

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getMessage, getModeratorActions, getModeratorStatus, getPageInfo, getParentId, getPublishDate, getReferrerUrl, getSourceComponentId, getState, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isClosed, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible

Methods inherited from interface com.adobe.cq.social.scf.SocialCollectionComponent

getItems, getTotalSize, setPagination, setSortedOrder

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

LAST_SELF_MOD_BY

static final java.lang.String LAST_SELF_MOD_BY

JCR properties that maintains the id of the user that effected the last modification of this topic.

See Also:

Constant Field Values

PN_NAME

static final java.lang.String PN_NAME

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Get the name of the asset

Returns:

String name

isFolder

boolean isFolder()

Check if this instance is a folder or a document.

Returns:

true if this is a folder

getFileLibraryId

java.lang.String getFileLibraryId()

Get the FileLibrary id for this asset.

Returns:

the FileLibrary id.

getFriendlyUrl

java.lang.String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface SocialComponent

Returns:

a search engine friendly url to render this post if this post is a topic. if the post is a topic, this is blank.

isFileLibraryClosed

boolean isFileLibraryClosed()

getParentName

java.lang.String getParentName()

getParentFriendlyUrl

java.lang.String getParentFriendlyUrl()