eu.lundegaard.liferay.db.setup.core

Class SetupArticles

java.lang.Object

eu.lundegaard.liferay.db.setup.core.SetupArticles

public final class SetupArticles
extends Object

Created by mapa, guno, Updated by: Jakub Jandak, jakub.jandak@lundegaard.eu, 2023

Method Summary

Modifier and Type	Method and Description
static void	addDDMStructure(eu.lundegaard.liferay.db.setup.domain.Structure structure, long groupId, long classNameId, long companyId) The method addDDMStructure adds a new structure to the Liferay portal based on the provided structure information.
static void	addDDMTemplate(eu.lundegaard.liferay.db.setup.domain.Adt template, long groupId, long companyId) This method adds an ADT (Asset Display Template) to Liferay portal.
static void	addDDMTemplate(eu.lundegaard.liferay.db.setup.domain.ArticleTemplate template, long groupId, long companyId) This method adds a DDMTemplate to the Liferay portal
static void	addJournalArticle(eu.lundegaard.liferay.db.setup.domain.Article article, long groupId, long companyId) This method creates a journal article in Liferay.
static void	processRelatedAssets(eu.lundegaard.liferay.db.setup.domain.Article article, com.liferay.journal.model.JournalArticle ja, long runAsUserId, long groupId, long companyId) This method process the related assets for a Journal Article.
static void	setupSiteArticles(eu.lundegaard.liferay.db.setup.domain.Site site, long groupId, long companyId)
static void	setupSiteStructuresAndTemplates(eu.lundegaard.liferay.db.setup.domain.Site site, long groupId, long companyId) This method is used to call setup actions on the Site object and groupId, companyId.

Methods inherited from class java.lang.Object

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

Method Detail

setupSiteStructuresAndTemplates

public static void setupSiteStructuresAndTemplates(eu.lundegaard.liferay.db.setup.domain.Site site,
                                                   long groupId,
                                                   long companyId)
                                            throws com.liferay.portal.kernel.exception.PortalException

This method is used to call setup actions on the Site object and groupId, companyId. It classifies into:

• Article Structure
• DDL Structure
• Article Template

If any exception occurs, it logs the error.

Parameters:

site - the Site object containing the structures and templates to be added

groupId - the group id where the structures and templates should be added

companyId - the company id of the group

Throws:

com.liferay.portal.kernel.exception.PortalException - if an error occurs while adding the structures or templates

setupSiteArticles

public static void setupSiteArticles(eu.lundegaard.liferay.db.setup.domain.Site site,
                                     long groupId,
                                     long companyId)
                              throws com.liferay.portal.kernel.exception.PortalException,
                                     com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addDDMStructure

public static void addDDMStructure(eu.lundegaard.liferay.db.setup.domain.Structure structure,
                                   long groupId,
                                   long classNameId,
                                   long companyId)
                            throws com.liferay.portal.kernel.exception.SystemException,
                                   com.liferay.portal.kernel.exception.PortalException,
                                   IOException,
                                   URISyntaxException

The method addDDMStructure adds a new structure to the Liferay portal based on the provided structure information. The structure must be in JSON format and it is expected to have certain attributes such as name, key, parent, etc. The method will also set up the permissions for the structure based on the rolePermissions provided in the structure.

Parameters:

structure - the structure to be added

groupId - the groupId to which the structure will belong

classNameId - the classNameId of the structure, this is typically the class name of the object associated with the structure

companyId - the companyId to which the structure will belong

Throws:

com.liferay.portal.kernel.exception.SystemException - thrown when there is a system error

com.liferay.portal.kernel.exception.PortalException - thrown when there is a portal error

IOException - thrown when there is an error reading the structure file

URISyntaxException - thrown when there is an error with the URI syntax

addDDMTemplate

public static void addDDMTemplate(eu.lundegaard.liferay.db.setup.domain.ArticleTemplate template,
                                  long groupId,
                                  long companyId)
                           throws com.liferay.portal.kernel.exception.SystemException,
                                  com.liferay.portal.kernel.exception.PortalException,
                                  IOException,
                                  URISyntaxException

This method adds a DDMTemplate to the Liferay portal

Parameters:

template - The article template to be added

groupId - The groupId where the template will be added

companyId - The companyId where the template will be added

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

IOException - if an IO exception occurred

URISyntaxException - if URI syntax exception occurred

addDDMTemplate

public static void addDDMTemplate(eu.lundegaard.liferay.db.setup.domain.Adt template,
                                  long groupId,
                                  long companyId)
                           throws com.liferay.portal.kernel.exception.SystemException,
                                  com.liferay.portal.kernel.exception.PortalException,
                                  IOException,
                                  URISyntaxException

This method adds an ADT (Asset Display Template) to Liferay portal.

Parameters:

template - an Adt object representing the ADT to be added

groupId - the ID of the group to which the ADT should be added

companyId - the ID of the company to which the ADT should be added

Throws:

com.liferay.portal.kernel.exception.SystemException - if there is a problem accessing Liferay's template services

com.liferay.portal.kernel.exception.PortalException - if there is a problem with the group or template information

IOException - if there is a problem reading the ADT's script file

URISyntaxException - if there is a problem with the file path of the ADT's script

addJournalArticle

public static void addJournalArticle(eu.lundegaard.liferay.db.setup.domain.Article article,
                                     long groupId,
                                     long companyId)

This method creates a journal article in Liferay. The method reads the content of the article from the file specified in the path attribute of the Article. And creates article with such content.

Parameters:

article - object that contains information about the article such as its title, path, and structure key.

groupId - specifies the group the article belongs to.

companyId - that specifies the company the article belongs to.

processRelatedAssets

public static void processRelatedAssets(eu.lundegaard.liferay.db.setup.domain.Article article,
                                        com.liferay.journal.model.JournalArticle ja,
                                        long runAsUserId,
                                        long groupId,
                                        long companyId)

This method process the related assets for a Journal Article. It adds or clears the related assets specified in the Article object.

Parameters:

article - the Article object that contains the related assets information

ja - the JournalArticle object that the related assets will be added or cleared from

runAsUserId - the user id used to perform the action

groupId - the id of the group the assets belong to

companyId - the id of the company the assets belong to