com.adobe.cq.social.srp

Interface SocialResourceProvider.PrefetchPerResult

Enclosing interface:

SocialResourceProvider

public static interface SocialResourceProvider.PrefetchPerResult

Used with SocialResourcePrefetch to specify additional resources to fetch.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAttachmentProperties() List of properties on children containing lists of attachments which should be fetched.
java.lang.String[]	getCountBaseTypes() List of base types of children whose count should be fetched.
java.lang.String[]	getRelatedResources() List of resource paths relative to the child which should be fetched as well.

Method Detail

getRelatedResources

java.lang.String[] getRelatedResources()

List of resource paths relative to the child which should be fetched as well. The paths returned are templates. A pair of slash (//%) is used to identify a point where a property interpolation is desired. E.g.: foo/prefix//%bar will take each child, find its bar property and load foo/prefix<barPropertyValue> note that to use the property value as a path element of its own you need: foo///%bar To use an interpolation embedded in the middle of a template use: foo/prefix//%bar//defaultValue//%/baz to get foo/prefix<barPropertyValue>/baz or foo/prefix//%bar//%suffix to get foo/prefix<barPropertyValue>suffix

Returns:

a list of path templates.

getAttachmentProperties

java.lang.String[] getAttachmentProperties()

List of properties on children containing lists of attachments which should be fetched.

Returns:

a list of property names of attachment lists.

getCountBaseTypes

java.lang.String[] getCountBaseTypes()

List of base types of children whose count should be fetched. E.g. social/components/comments might be used to fetch the count of replies for each comment child.

Returns:

a list of base types.