com.adobe.cq.social.enablement.view.api.EnablementResourceView Maven / Gradle / Ivy
/*************************************************************************
*
* ADOBE CONFIDENTIAL
* __________________
*
* Copyright 2016 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any. The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
**************************************************************************/
package com.adobe.cq.social.enablement.view.api;
import javax.jcr.RepositoryException;
import aQute.bnd.annotation.ProviderType;
import com.adobe.cq.social.enablement.reporting.model.api.EnablementResourceUserReportModel;
import com.adobe.cq.social.enablement.resource.model.api.EnablementAssetModel;
import com.adobe.cq.social.enablement.resource.model.api.EnablementAuthorizables;
import com.adobe.cq.social.enablement.resource.model.api.EnablementResourceModel;
import com.adobe.cq.social.scf.SocialComponent;
@ProviderType
public interface EnablementResourceView extends SocialComponent {
public static final String RESOURCE_TYPE = "social/enablement/components/hbs/view/resource";
/**
* @return resource title
*/
public String getTitle();
/*
* (non-Javadoc)
* @see com.adobe.cq.social.scf.SocialComponent#getFriendlyUrl()
*/
public String getFriendlyUrl();
/**
* @return Site Path
*/
public String getSitePagePath();
/**
* @return resource cover image
*/
public String getCoverImage();
/**
* @return get the card image path
*/
public String getCardImagePath();
/**
* @return resource description
*/
public String getDescription();
/**
* @return resource site id
*/
public String getSiteId();
/**
* @return resource site language
*/
public String getLanguage();
/**
* @return resource date
*/
public String getFriendlyDueDate();
/**
* @return resource due status
*/
public String getDueStatus();
/**
* @return resource id
*/
public String getResourceId();
/**
* @return resource id
*/
public String getResourceUID();
/**
* Gets the list of tagIds associated with the given Enablement content.
* @return list of tagIds
* @throws RepositoryException on failure
*/
public String[] getResourceTags() throws RepositoryException;
/**
* @return resource is published
*/
public Boolean getIsPublished();
/**
* @return resource allow anonymous
*/
public Boolean getAllowAnonymous();
/**
* @return allow catalog visibility
*/
Boolean getAllowCatalogVisibility();
/**
* @return path to the primary asset
*/
public String getResourceAssetPath();
/**
* @return path representing the enablement resource comments endpoint
*/
public String getCommentsEndpoint();
/**
* @return path representing the enablement resource ratings endpoint
*/
public String getRatingsEndpoint();
/**
* Returns an object representing the primary resource asset.
* @return primary asset
*/
public EnablementAssetModel getPrimaryAsset();
/**
* Returns an object representing the resource large asset.
* @return large asset
*/
public EnablementAssetModel getLargeAsset();
/**
* Returns an object representing the resource small asset.
* @return small asset
*/
public EnablementAssetModel getSmallAsset();
/**
* Returns an object representing the resource content fragment asset.
* @return fragment asset
*/
public EnablementAssetModel getFragmentAsset();
/**
* Returns an object representing the contacts
* @return contacts
*/
public EnablementAuthorizables getContacts();
/**
* Returns an object representing the authors
* @return authors
*/
public EnablementAuthorizables getAuthors();
/**
* Returns an object representing the experts
* @return experts
*/
public EnablementAuthorizables getExperts();
/**
* Returns an object representing the assignees
* @return assignees
*/
public EnablementAuthorizables getAssignees();
/**
* @return enablement type
*/
public String getEnablementType();
/**
* @return user report
*/
public EnablementResourceUserReportModel getUserReport();
/**
* @return primary asset type
*/
public String getPrimaryAssetType();
/**
* @return enablement resource model
*/
public EnablementResourceModel getEnablementResourceModel();
/**
* Gets the marketing cloud org id, which is required for video heartbeat analytics
* @return marketing cloud org id
*/
public String getMarketingCloudOrgId();
}