com.adobe.cq.social.enablement.view.api.EnablementLearningPathView 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 java.util.List;

import javax.jcr.RepositoryException;

import com.adobe.cq.social.enablement.learningpath.model.api.EnablementLearningPathPrerequisite;
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.SocialCollectionComponent;

/**
 * @author akeith
 */
public interface EnablementLearningPathView extends SocialCollectionComponent {

    public static final String RESOURCE_TYPE = "social/enablement/components/hbs/view/learningpath";

    /**
     * @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 id
     */
    public String getResourceId();

    /**
     * @return resource unique 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 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 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 All Prerequisites Completed
     */
    public Boolean getAllPrerequisitesCompleted();

    public EnablementResourceUserReportModel getUserReport();

    public EnablementResourceModel getEnablementResourceModel();

    /**
     * @return enablement type
     */
    public String getEnablementType();

    public List getPrerequisites();

    public List getUnfinishedPrerequisites();

    public Boolean getEnforceOrder();

    /**
     * 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();

}