com.liferay.portlet.journal.service
Class JournalTemplateLocalServiceUtil

java.lang.Object
  com.liferay.portlet.journal.service.JournalTemplateLocalServiceUtil

public class JournalTemplateLocalServiceUtil
extends Object

The utility for the journal template local service. This utility wraps com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

JournalTemplateLocalService, com.liferay.portlet.journal.service.base.JournalTemplateLocalServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalTemplateLocalServiceImpl

Constructor Summary

JournalTemplateLocalServiceUtil()

Method Summary

static JournalTemplate	addJournalTemplate(JournalTemplate journalTemplate) Adds the journal template to the database.
static JournalTemplate	addTemplate(long userId, long groupId, String templateId, boolean autoTemplateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, ServiceContext serviceContext)
static void	addTemplateResources(JournalTemplate template, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addTemplateResources(JournalTemplate template, String[] groupPermissions, String[] guestPermissions)
static void	addTemplateResources(long groupId, String templateId, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addTemplateResources(long groupId, String templateId, String[] groupPermissions, String[] guestPermissions)
static void	checkNewLine(long groupId, String templateId)
static JournalTemplate	copyTemplate(long userId, long groupId, String oldTemplateId, String newTemplateId, boolean autoTemplateId)
static JournalTemplate	createJournalTemplate(long id) Creates a new journal template with the primary key.
static JournalTemplate	deleteJournalTemplate(JournalTemplate journalTemplate) Deletes the journal template from the database.
static JournalTemplate	deleteJournalTemplate(long id) Deletes the journal template with the primary key from the database.
static void	deleteTemplate(JournalTemplate template)
static void	deleteTemplate(long groupId, String templateId)
static void	deleteTemplates(long groupId)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static JournalTemplate	fetchJournalTemplate(long id)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static JournalTemplate	getJournalTemplate(long id) Returns the journal template with the primary key.
static JournalTemplate	getJournalTemplateByUuidAndGroupId(String uuid, long groupId) Returns the journal template with the UUID in the group.
static List<JournalTemplate>	getJournalTemplates(int start, int end) Returns a range of all the journal templates.
static int	getJournalTemplatesCount() Returns the number of journal templates.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static JournalTemplateLocalService	getService()
static List<JournalTemplate>	getStructureTemplates(long groupId, String structureId)
static List<JournalTemplate>	getStructureTemplates(long groupId, String structureId, int start, int end)
static int	getStructureTemplatesCount(long groupId, String structureId)
static JournalTemplate	getTemplate(long id)
static JournalTemplate	getTemplate(long groupId, String templateId)
static JournalTemplate	getTemplate(long groupId, String templateId, boolean includeGlobalTemplates)
static JournalTemplate	getTemplateBySmallImageId(long smallImageId)
static List<JournalTemplate>	getTemplates()
static List<JournalTemplate>	getTemplates(long groupId)
static List<JournalTemplate>	getTemplates(long groupId, int start, int end)
static int	getTemplatesCount(long groupId)
static boolean	hasTemplate(long groupId, String templateId)
static List<JournalTemplate>	search(long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator, int start, int end, OrderByComparator obc)
static List<JournalTemplate>	search(long companyId, long[] groupIds, String templateId, String structureId, String structureIdComparator, String name, String description, boolean andOperator, int start, int end, OrderByComparator obc)
static int	searchCount(long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator)
static int	searchCount(long companyId, long[] groupIds, String templateId, String structureId, String structureIdComparator, String name, String description, boolean andOperator)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(JournalTemplateLocalService service) Deprecated.
static JournalTemplate	updateJournalTemplate(JournalTemplate journalTemplate) Updates the journal template in the database or adds it if it does not yet exist.
static JournalTemplate	updateJournalTemplate(JournalTemplate journalTemplate, boolean merge) Updates the journal template in the database or adds it if it does not yet exist.
static JournalTemplate	updateTemplate(long groupId, String templateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalTemplateLocalServiceUtil

public JournalTemplateLocalServiceUtil()

Method Detail

addJournalTemplate

public static JournalTemplate addJournalTemplate(JournalTemplate journalTemplate)
                                          throws SystemException

Adds the journal template to the database. Also notifies the appropriate model listeners.

Parameters:

journalTemplate - the journal template

Returns:

the journal template that was added

Throws:

SystemException - if a system exception occurred

createJournalTemplate

public static JournalTemplate createJournalTemplate(long id)

Creates a new journal template with the primary key. Does not add the journal template to the database.

Parameters:

id - the primary key for the new journal template

Returns:

the new journal template

deleteJournalTemplate

public static JournalTemplate deleteJournalTemplate(long id)
                                             throws PortalException,
                                                    SystemException

Deletes the journal template with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

id - the primary key of the journal template

Returns:

the journal template that was removed

Throws:

PortalException - if a journal template with the primary key could not be found

SystemException - if a system exception occurred

deleteJournalTemplate

public static JournalTemplate deleteJournalTemplate(JournalTemplate journalTemplate)
                                             throws SystemException

Deletes the journal template from the database. Also notifies the appropriate model listeners.

Parameters:

journalTemplate - the journal template

Returns:

the journal template that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchJournalTemplate

public static JournalTemplate fetchJournalTemplate(long id)
                                            throws SystemException

Throws:

SystemException

getJournalTemplate

public static JournalTemplate getJournalTemplate(long id)
                                          throws PortalException,
                                                 SystemException

Returns the journal template with the primary key.

Parameters:

id - the primary key of the journal template

Returns:

the journal template

Throws:

PortalException - if a journal template with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getJournalTemplateByUuidAndGroupId

public static JournalTemplate getJournalTemplateByUuidAndGroupId(String uuid,
                                                                 long groupId)
                                                          throws PortalException,
                                                                 SystemException

Returns the journal template with the UUID in the group.

Parameters:

uuid - the UUID of journal template

groupId - the group id of the journal template

Returns:

the journal template

Throws:

PortalException - if a journal template with the UUID in the group could not be found

SystemException - if a system exception occurred

getJournalTemplates

public static List<JournalTemplate> getJournalTemplates(int start,
                                                        int end)
                                                 throws SystemException

Returns a range of all the journal templates.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of journal templates

end - the upper bound of the range of journal templates (not inclusive)

Returns:

the range of journal templates

Throws:

SystemException - if a system exception occurred

getJournalTemplatesCount

public static int getJournalTemplatesCount()
                                    throws SystemException

Returns the number of journal templates.

Returns:

the number of journal templates

Throws:

SystemException - if a system exception occurred

updateJournalTemplate

public static JournalTemplate updateJournalTemplate(JournalTemplate journalTemplate)
                                             throws SystemException

Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

journalTemplate - the journal template

Returns:

the journal template that was updated

Throws:

SystemException - if a system exception occurred

updateJournalTemplate

public static JournalTemplate updateJournalTemplate(JournalTemplate journalTemplate,
                                                    boolean merge)
                                             throws SystemException

Updates the journal template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

journalTemplate - the journal template

merge - whether to merge the journal template with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the journal template that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addTemplate

public static JournalTemplate addTemplate(long userId,
                                          long groupId,
                                          String templateId,
                                          boolean autoTemplateId,
                                          String structureId,
                                          Map<Locale,String> nameMap,
                                          Map<Locale,String> descriptionMap,
                                          String xsl,
                                          boolean formatXsl,
                                          String langType,
                                          boolean cacheable,
                                          boolean smallImage,
                                          String smallImageURL,
                                          File smallImageFile,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

addTemplateResources

public static void addTemplateResources(JournalTemplate template,
                                        boolean addGroupPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addTemplateResources

public static void addTemplateResources(JournalTemplate template,
                                        String[] groupPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addTemplateResources

public static void addTemplateResources(long groupId,
                                        String templateId,
                                        boolean addGroupPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addTemplateResources

public static void addTemplateResources(long groupId,
                                        String templateId,
                                        String[] groupPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

checkNewLine

public static void checkNewLine(long groupId,
                                String templateId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

copyTemplate

public static JournalTemplate copyTemplate(long userId,
                                           long groupId,
                                           String oldTemplateId,
                                           String newTemplateId,
                                           boolean autoTemplateId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteTemplate

public static void deleteTemplate(JournalTemplate template)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteTemplate

public static void deleteTemplate(long groupId,
                                  String templateId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteTemplates

public static void deleteTemplates(long groupId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getStructureTemplates

public static List<JournalTemplate> getStructureTemplates(long groupId,
                                                          String structureId)
                                                   throws SystemException

Throws:

SystemException

getStructureTemplates

public static List<JournalTemplate> getStructureTemplates(long groupId,
                                                          String structureId,
                                                          int start,
                                                          int end)
                                                   throws SystemException

Throws:

SystemException

getStructureTemplatesCount

public static int getStructureTemplatesCount(long groupId,
                                             String structureId)
                                      throws SystemException

Throws:

SystemException

getTemplate

public static JournalTemplate getTemplate(long id)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getTemplate

public static JournalTemplate getTemplate(long groupId,
                                          String templateId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getTemplate

public static JournalTemplate getTemplate(long groupId,
                                          String templateId,
                                          boolean includeGlobalTemplates)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getTemplateBySmallImageId

public static JournalTemplate getTemplateBySmallImageId(long smallImageId)
                                                 throws PortalException,
                                                        SystemException

Throws:

PortalException

SystemException

getTemplates

public static List<JournalTemplate> getTemplates()
                                          throws SystemException

Throws:

SystemException

getTemplates

public static List<JournalTemplate> getTemplates(long groupId)
                                          throws SystemException

Throws:

SystemException

getTemplates

public static List<JournalTemplate> getTemplates(long groupId,
                                                 int start,
                                                 int end)
                                          throws SystemException

Throws:

SystemException

getTemplatesCount

public static int getTemplatesCount(long groupId)
                             throws SystemException

Throws:

SystemException

hasTemplate

public static boolean hasTemplate(long groupId,
                                  String templateId)
                           throws SystemException

Throws:

SystemException

search

public static List<JournalTemplate> search(long companyId,
                                           long[] groupIds,
                                           String keywords,
                                           String structureId,
                                           String structureIdComparator,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws SystemException

Throws:

SystemException

search

public static List<JournalTemplate> search(long companyId,
                                           long[] groupIds,
                                           String templateId,
                                           String structureId,
                                           String structureIdComparator,
                                           String name,
                                           String description,
                                           boolean andOperator,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              String keywords,
                              String structureId,
                              String structureIdComparator)
                       throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              String templateId,
                              String structureId,
                              String structureIdComparator,
                              String name,
                              String description,
                              boolean andOperator)
                       throws SystemException

Throws:

SystemException

updateTemplate

public static JournalTemplate updateTemplate(long groupId,
                                             String templateId,
                                             String structureId,
                                             Map<Locale,String> nameMap,
                                             Map<Locale,String> descriptionMap,
                                             String xsl,
                                             boolean formatXsl,
                                             String langType,
                                             boolean cacheable,
                                             boolean smallImage,
                                             String smallImageURL,
                                             File smallImageFile,
                                             ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getService

public static JournalTemplateLocalService getService()

setService

public void setService(JournalTemplateLocalService service)

Deprecated.