com.adobe.cq.social.enablement.services.api

Class ResourceDetailsImpl

java.lang.Object

com.adobe.cq.social.enablement.services.api.ResourceDetailsImpl

public class ResourceDetailsImpl
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASSET_ARRAY
static java.lang.String	RATINGS_OBJECT
static java.lang.String	RESOURCE_INFO

Constructor Summary

Constructors

Constructor and Description
ResourceDetailsImpl()

Method Summary

Modifier and Type	Method and Description
JSONObject	getResourceDetails(Resource resource) Get the resource's detail at the pointed to by the resource.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_INFO

public static final java.lang.String RESOURCE_INFO

See Also:

Constant Field Values

ASSET_ARRAY

public static final java.lang.String ASSET_ARRAY

See Also:

Constant Field Values

RATINGS_OBJECT

public static final java.lang.String RATINGS_OBJECT

See Also:

Constant Field Values

Constructor Detail

ResourceDetailsImpl

public ResourceDetailsImpl()

Method Detail

getResourceDetails

public JSONObject getResourceDetails(Resource resource)
                              throws RepositoryException,
                                     TallyException,
                                     JSONException

Get the resource's detail at the pointed to by the resource.

Parameters:

resource - Resource for which com.adobe.cq.social.enablement.model.EnablementResource 's details are required

Returns:

JSONObject with following properties:

• RESOURCE_INFO: value of 1st level properties of resource node in JCR
• ASSET_ARRAY: value as an array of assets participating in this resource. This array would consist of objects with properties:
  • ASSET_NAME
  • ASSET_END_POINT
  • ASSET_COVER_IMAGE_URL
  • ASSET_MIME_TYPE
• RATINGS_OBJECT: this object would have following rating related properties:
  • RATINGS_USER: rating by the current user as a number
  • RATINGS_USER_STRING: string message representing rating by the current user
  • RATINGS_AVG: average rating as a number
  • RATINGS_COUNT: count of ratings
• USER_INTERATION_WATCHED: true/false (missing property implies false)
• USER_INTERATION_PINNED: true/false (missing property implies false)

Sample Response:

 {
     //1st level resource information saved in a resource node in JCR(essentially <resource-end-point>.json)
     "info": {
         "jcr:primaryType": "nt:unstructured",
         "jcr:mixinTypes": ["rep:AccessControllable"],
         "allow-social-switch": false,
         "resource-experts": [],
         "description": "Tutorial on AEM",
         "cover-image-path": "./cover-image/file/image",
         "resource-managers": [],
         "allow-ratings": false,
         "date-modified": "Tue Feb 11 2014 19:19:05 GMT+0530",
         "is-mandatory": false,
         "publish": true,
         "id": "101",
         "url": "",
         "name": "AEM Training2",
         "tags": ["adobe:social"],
         "category": ["adobe:aem"],
         "resource-contact": [],
         "date-created": "Tue Feb 11 2014 19:19:05 GMT+0530",
         "moderate-comments": true,
         "catalog-visibility": "open",
         "created-by": "nikeadmin",
         "allow-comments": false
     },
     //asset list for this resource with some meta-information about asset.
     //The meta info about asset is basically with guidance that what information is relevant to be
     //shown while detailing asset(suggestion needed--a few guesses by me: duration, pages[if applicable]
     //more specific info about asset(like video progress) need to be pulled from asset end-point
     "assets": [ //0..*
         {
             "name": "KB2.mp4",
             "end-point": "/content/enablement/data/nike/resources/nikeadmin/AEMTraining/assets/asset1/jcr:content",
             "cover-image-path": "/content/enablement/data/nike/resources/nikeadmin/AEMTraining/assets/asset1/cover-img/image",
             "type": "video/mp4",
         },
         {
             "name": "IMG_3418.jpg",
             "end-point": "/content/enablement/data/nike/resources/nikeadmin/AEMTraining/assets/asset2/jcr:content",
             "cover-image-path": "/content/enablement/data/nike/resources/nikeadmin/AEMTraining/assets/asset2/cover-img/image",
             "type": "image/jpeg",
         }
     ],
     "ratings": {
             "count": 1,
             "average": 3,
             "user-rating": 3, //(optional)
             "user-rating-string": "3.0" //(optional)
     }
 }
 

Throws:

RepositoryException - -- throws exception when unable to find the resource

TallyException - -- generic exception for all failures in the Tally API.

JSONException - -- throws when there are issue with the JSON