com.liferay.portlet.journal.service
Interface JournalTemplateService

All Superinterfaces:

BaseService

All Known Implementing Classes:

JournalTemplateServiceWrapper

@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface JournalTemplateService
extends BaseService

The interface for the journal template remote service.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

JournalTemplateServiceUtil, com.liferay.portlet.journal.service.base.JournalTemplateServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalTemplateServiceImpl

Method Summary

JournalTemplate	addTemplate(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 smallFile, ServiceContext serviceContext)
JournalTemplate	addTemplate(long groupId, String templateId, boolean autoTemplateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, ServiceContext serviceContext)
JournalTemplate	copyTemplate(long groupId, String oldTemplateId, String newTemplateId, boolean autoTemplateId)
void	deleteTemplate(long groupId, String templateId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
List<JournalTemplate>	getStructureTemplates(long groupId, String structureId)
JournalTemplate	getTemplate(long groupId, String templateId)
JournalTemplate	getTemplate(long groupId, String templateId, boolean includeGlobalTemplates)
List<JournalTemplate>	search(long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator, int start, int end, OrderByComparator obc)
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)
int	searchCount(long companyId, long[] groupIds, String keywords, String structureId, String structureIdComparator)
int	searchCount(long companyId, long[] groupIds, String templateId, String structureId, String structureIdComparator, String name, String description, boolean andOperator)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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 smallFile, ServiceContext serviceContext)
JournalTemplate	updateTemplate(long groupId, String templateId, String structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsl, boolean formatXsl, String langType, boolean cacheable, ServiceContext serviceContext)

Method Detail

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addTemplate

JournalTemplate addTemplate(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 smallFile,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

addTemplate

JournalTemplate addTemplate(long groupId,
                            String templateId,
                            boolean autoTemplateId,
                            String structureId,
                            Map<Locale,String> nameMap,
                            Map<Locale,String> descriptionMap,
                            String xsl,
                            boolean formatXsl,
                            String langType,
                            boolean cacheable,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

copyTemplate

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

Throws:

PortalException

SystemException

deleteTemplate

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

Throws:

PortalException

SystemException

getStructureTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalTemplate> getStructureTemplates(long groupId,
                                                                                     String structureId)
                                            throws SystemException

Throws:

SystemException

getTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalTemplate getTemplate(long groupId,
                                                                     String templateId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalTemplate getTemplate(long groupId,
                                                                     String templateId,
                                                                     boolean includeGlobalTemplates)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalTemplate> search(long companyId,
                                                                      long[] groupIds,
                                                                      String keywords,
                                                                      String structureId,
                                                                      String structureIdComparator,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator obc)
                             throws SystemException

Throws:

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         String keywords,
                                                         String structureId,
                                                         String structureIdComparator)
                throws SystemException

Throws:

SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         String templateId,
                                                         String structureId,
                                                         String structureIdComparator,
                                                         String name,
                                                         String description,
                                                         boolean andOperator)
                throws SystemException

Throws:

SystemException

updateTemplate

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 smallFile,
                               ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

updateTemplate

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

Throws:

PortalException

SystemException