com.liferay.portlet.journal.service
Interface JournalTemplateLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

JournalTemplateLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface JournalTemplateLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the journal template local service.

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:

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

Method Summary

JournalTemplate	addJournalTemplate(JournalTemplate journalTemplate) Adds the journal template to the database.
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)
void	addTemplateResources(JournalTemplate template, boolean addGroupPermissions, boolean addGuestPermissions)
void	addTemplateResources(JournalTemplate template, String[] groupPermissions, String[] guestPermissions)
void	addTemplateResources(long groupId, String templateId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addTemplateResources(long groupId, String templateId, String[] groupPermissions, String[] guestPermissions)
void	checkNewLine(long groupId, String templateId)
JournalTemplate	copyTemplate(long userId, long groupId, String oldTemplateId, String newTemplateId, boolean autoTemplateId)
JournalTemplate	createJournalTemplate(long id) Creates a new journal template with the primary key.
JournalTemplate	deleteJournalTemplate(JournalTemplate journalTemplate) Deletes the journal template from the database.
JournalTemplate	deleteJournalTemplate(long id) Deletes the journal template with the primary key from the database.
void	deleteTemplate(JournalTemplate template)
void	deleteTemplate(long groupId, String templateId)
void	deleteTemplates(long groupId)
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
JournalTemplate	fetchJournalTemplate(long id)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
JournalTemplate	getJournalTemplate(long id) Returns the journal template with the primary key.
JournalTemplate	getJournalTemplateByUuidAndGroupId(String uuid, long groupId) Returns the journal template with the UUID in the group.
List<JournalTemplate>	getJournalTemplates(int start, int end) Returns a range of all the journal templates.
int	getJournalTemplatesCount() Returns the number of journal templates.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<JournalTemplate>	getStructureTemplates(long groupId, String structureId)
List<JournalTemplate>	getStructureTemplates(long groupId, String structureId, int start, int end)
int	getStructureTemplatesCount(long groupId, String structureId)
JournalTemplate	getTemplate(long id)
JournalTemplate	getTemplate(long groupId, String templateId)
JournalTemplate	getTemplate(long groupId, String templateId, boolean includeGlobalTemplates)
JournalTemplate	getTemplateBySmallImageId(long smallImageId)
List<JournalTemplate>	getTemplates()
List<JournalTemplate>	getTemplates(long groupId)
List<JournalTemplate>	getTemplates(long groupId, int start, int end)
int	getTemplatesCount(long groupId)
boolean	hasTemplate(long groupId, String templateId)
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	updateJournalTemplate(JournalTemplate journalTemplate) Updates the journal template in the database or adds it if it does not yet exist.
JournalTemplate	updateJournalTemplate(JournalTemplate journalTemplate, boolean merge) Updates the journal template in the database or adds it if it does not yet exist.
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)

Method Detail

addJournalTemplate

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalTemplate fetchJournalTemplate(long id)
                                     throws SystemException

Throws:

SystemException

getJournalTemplate

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getJournalTemplateByUuidAndGroupId

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getJournalTemplatesCount()
                             throws SystemException

Returns the number of journal templates.

Returns:

the number of journal templates

Throws:

SystemException - if a system exception occurred

updateJournalTemplate

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

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

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 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

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

Throws:

PortalException

SystemException

addTemplateResources

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

Throws:

PortalException

SystemException

addTemplateResources

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

Throws:

PortalException

SystemException

addTemplateResources

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

Throws:

PortalException

SystemException

checkNewLine

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

Throws:

PortalException

SystemException

copyTemplate

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

Throws:

PortalException

SystemException

deleteTemplate

void deleteTemplate(JournalTemplate template)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteTemplate

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

Throws:

PortalException

SystemException

deleteTemplates

void deleteTemplates(long groupId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getStructureTemplates

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

Throws:

SystemException

getStructureTemplates

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

Throws:

SystemException

getStructureTemplatesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStructureTemplatesCount(long groupId,
                                                                        String structureId)
                               throws SystemException

Throws:

SystemException

getTemplate

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

Throws:

PortalException

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

getTemplateBySmallImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalTemplate getTemplateBySmallImageId(long smallImageId)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalTemplate> getTemplates()
                                   throws SystemException

Throws:

SystemException

getTemplates

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

Throws:

SystemException

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalTemplate> getTemplates(long groupId,
                                                                            int start,
                                                                            int end)
                                   throws SystemException

Throws:

SystemException

getTemplatesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesCount(long groupId)
                      throws SystemException

Throws:

SystemException

hasTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTemplate(long groupId,
                                                             String templateId)
                    throws SystemException

Throws:

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

Throws:

PortalException

SystemException