com.adobe.cq.mobile.dps

Interface DPSProject

All Superinterfaces:

Adaptable, DPSObject

public interface DPSProject
extends DPSObject

Defines a DPS Project

Since:

6.2

Method Summary

Modifier and Type	Method and Description
DPSArticle	getArticle(String name) Get an article by its name
List<DPSArticle>	getArticles() Get all articles
List<DPSArticle>	getArticles(Resource folder) Get articles under a folder
DPSBanner	getBanner(String name) Get an banner by its name
List<DPSBanner>	getBanners() Get all banners
List<DPSBanner>	getBanners(Resource folder) Get banners under a folder
DPSCollection	getCollection(String name) Get an Collection by its name
List<DPSCollection>	getCollections() Get all Collections
List<DPSCollection>	getCollections(Resource folder) Get all Collections under a folder
String	getDescription()
Configuration	getDPSConfiguration() Returns DPS Configuration
String	getExportTemplatePath() Returns the content sync template path.
Date	getLastHTMLResourceDPSUpload()
String	getLastHTMLResourceDPSUploadBy()

Methods inherited from interface com.adobe.cq.mobile.dps.DPSObject

getCreated, getCreatedBy, getDPSResourceType, getId, getLastCQModified, getLastCQModifiedBy, getName, getPath, getProjectId, getTitle, toJSON

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Method Detail

getDescription

String getDescription()

getArticles

List<DPSArticle> getArticles()

Get all articles

Returns:

article list

getArticles

List<DPSArticle> getArticles(Resource folder)

Get articles under a folder

Returns:

article list

getArticle

DPSArticle getArticle(String name)

Get an article by its name

Returns:

article if found, null otherwise

getBanners

List<DPSBanner> getBanners()

Get all banners

Returns:

banner list

getBanners

List<DPSBanner> getBanners(Resource folder)

Get banners under a folder

Returns:

banner list

getBanner

DPSBanner getBanner(String name)

Get an banner by its name

Returns:

banner if found, null otherwise

getCollections

List<DPSCollection> getCollections()

Get all Collections

Returns:

Collection list

getCollections

List<DPSCollection> getCollections(Resource folder)

Get all Collections under a folder

Returns:

Collection list

getCollection

DPSCollection getCollection(String name)

Get an Collection by its name

Returns:

Collection if found, null otherwise

getExportTemplatePath

String getExportTemplatePath()

Returns the content sync template path.

Returns:

the path to the export template.

getDPSConfiguration

Configuration getDPSConfiguration()
                           throws DPSException

Returns DPS Configuration

Returns:

DPS Configuration if set, null otherwise

Throws:

DPSException

getLastHTMLResourceDPSUpload

Date getLastHTMLResourceDPSUpload()

Returns:

last time shared HTMLResources were uploaded, null if not uploaded

getLastHTMLResourceDPSUploadBy

String getLastHTMLResourceDPSUploadBy()

Returns:

last user to upload shared HTMLResources, null if not uploaded