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

Class AbstractAsset<T extends FileLibraryConfiguration>

java.lang.Object

com.adobe.cq.social.scf.core.BaseSocialComponent

com.adobe.cq.social.commons.comments.api.AbstractComment<T>

com.adobe.cq.social.filelibrary.client.api.AbstractAsset<T>

All Implemented Interfaces:

Comment<T>, Asset<T>, SocialCollectionComponent, SocialComponent

public abstract class AbstractAsset<T extends FileLibraryConfiguration>
extends AbstractComment<T>
implements Asset<T>

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 inherited from interface com.adobe.cq.social.filelibrary.client.api.Asset

LAST_SELF_MOD_BY, 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

Constructor Summary

Constructors

Constructor and Description
AbstractAsset(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager listProviderManager)
AbstractAsset(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager listProviderManager) Constructor of an asset.

Method Summary

Modifier and Type	Method and Description
T	createConfiguration(Resource resource, Resource cs) Obtain the configuration for this comment.
java.util.List<FileLibraryBreadcrumb>	getBreadcrumbs()
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
PageInfo	getPageInfo() Gets information about the pages for this collection.
java.lang.String	getParentFriendlyUrl()
java.lang.String	getParentName()
boolean	isFileLibraryClosed()
boolean	isFolder() Check if this instance is a folder or a document.
void	setPagination(CollectionPagination pagination) Set the collection list range.

Methods inherited from class com.adobe.cq.social.commons.comments.api.AbstractComment

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getItems, getMessage, getModeratorActions, getModeratorStatus, getParent, getParentComponent, getParentId, getPublishDate, getReferrerUrl, getResourceType, getSourceComponent, getSourceComponentId, getState, getTags, getTotalSize, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isClosed, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible, setSortedOrder, setSortFields, toString

Methods inherited from class com.adobe.cq.social.scf.core.BaseSocialComponent

buildJSONString, getAsMap, getId, getProperties, getProperty, getProperty, getResource, getUrl, toJSONString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, 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, setSortedOrder

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

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

Constructor Detail

AbstractAsset

public AbstractAsset(Resource resource,
                     ClientUtilities clientUtils,
                     CommentSocialComponentListProviderManager listProviderManager)
              throws RepositoryException

Throws:

RepositoryException

AbstractAsset

public AbstractAsset(Resource resource,
                     ClientUtilities clientUtils,
                     QueryRequestInfo queryInfo,
                     CommentSocialComponentListProviderManager listProviderManager)
              throws RepositoryException

Constructor of an asset.

Parameters:

resource - the specified resource

clientUtils - the client utilities instance

queryInfo - QueryRequestInfo

listProviderManager - CommentSocialComponentListProviderManager

Throws:

RepositoryException - if an error occurs

Method Detail

getBreadcrumbs

public java.util.List<FileLibraryBreadcrumb> getBreadcrumbs()

getName

public java.lang.String getName()

Get the name of the asset

Specified by:

getName in interface Asset<T extends FileLibraryConfiguration>

Returns:

String name

isFolder

public boolean isFolder()

Check if this instance is a folder or a document.

Specified by:

isFolder in interface Asset<T extends FileLibraryConfiguration>

Returns:

true if this is a folder

getFileLibraryId

public java.lang.String getFileLibraryId()

Get the FileLibrary id for this asset.

Specified by:

getFileLibraryId in interface Asset<T extends FileLibraryConfiguration>

Returns:

the FileLibrary id.

isFileLibraryClosed

public boolean isFileLibraryClosed()

Specified by:

isFileLibraryClosed in interface Asset<T extends FileLibraryConfiguration>

getFriendlyUrl

public 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 Asset<T extends FileLibraryConfiguration>

Specified by:

getFriendlyUrl in interface SocialComponent

Overrides:

getFriendlyUrl in class AbstractComment<T extends FileLibraryConfiguration>

Returns:

friendlyURL String

setPagination

public void setPagination(CollectionPagination pagination)

Description copied from class: AbstractComment

Set the collection list range. If this is not set, then the return list will start at offset 0 and the default size

Specified by:

setPagination in interface SocialCollectionComponent

Overrides:

setPagination in class AbstractComment<T extends FileLibraryConfiguration>

Parameters:

pagination - detail information to use

createConfiguration

public T createConfiguration(Resource resource,
                             Resource cs)

Description copied from class: AbstractComment

Obtain the configuration for this comment.

Parameters:

resource - The comment resource

cs - Resource

Returns:

T type

getParentName

public java.lang.String getParentName()

Specified by:

getParentName in interface Asset<T extends FileLibraryConfiguration>

getParentFriendlyUrl

public java.lang.String getParentFriendlyUrl()

Specified by:

getParentFriendlyUrl in interface Asset<T extends FileLibraryConfiguration>

getPageInfo

public PageInfo getPageInfo()

Description copied from class: AbstractComment

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Specified by:

getPageInfo in interface Comment<T extends FileLibraryConfiguration>

Overrides:

getPageInfo in class AbstractComment<T extends FileLibraryConfiguration>

Returns:

information about the pagination system