com.liferay.portlet.journal.service
Interface JournalStructureService

All Superinterfaces:

BaseService

All Known Implementing Classes:

JournalStructureServiceWrapper

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

The interface for the journal structure 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:

JournalStructureServiceUtil, com.liferay.portlet.journal.service.base.JournalStructureServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalStructureServiceImpl

Method Summary

JournalStructure	addStructure(long groupId, String structureId, boolean autoStructureId, String parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
JournalStructure	copyStructure(long groupId, String oldStructureId, String newStructureId, boolean autoStructureId)
void	deleteStructure(long groupId, String structureId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
JournalStructure	getStructure(long groupId, String structureId)
JournalStructure	getStructure(long groupId, String structureId, boolean includeGlobalStructures)
List<JournalStructure>	getStructures(long groupId)
List<JournalStructure>	search(long companyId, long[] groupIds, String keywords, int start, int end, OrderByComparator obc)
List<JournalStructure>	search(long companyId, long[] groupIds, String structureId, String name, String description, boolean andOperator, int start, int end, OrderByComparator obc)
int	searchCount(long companyId, long[] groupIds, String keywords)
int	searchCount(long companyId, long[] groupIds, String structureId, String name, String description, boolean andOperator)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
JournalStructure	updateStructure(long groupId, String structureId, String parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, 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

addStructure

JournalStructure addStructure(long groupId,
                              String structureId,
                              boolean autoStructureId,
                              String parentStructureId,
                              Map<Locale,String> nameMap,
                              Map<Locale,String> descriptionMap,
                              String xsd,
                              ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

copyStructure

JournalStructure copyStructure(long groupId,
                               String oldStructureId,
                               String newStructureId,
                               boolean autoStructureId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

deleteStructure

void deleteStructure(long groupId,
                     String structureId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getStructure(long groupId,
                                                                       String structureId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getStructure(long groupId,
                                                                       String structureId,
                                                                       boolean includeGlobalStructures)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getStructures

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

Throws:

SystemException

search

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

Throws:

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> search(long companyId,
                                                                       long[] groupIds,
                                                                       String structureId,
                                                                       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)
                throws SystemException

Throws:

SystemException

searchCount

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

Throws:

SystemException

updateStructure

JournalStructure updateStructure(long groupId,
                                 String structureId,
                                 String parentStructureId,
                                 Map<Locale,String> nameMap,
                                 Map<Locale,String> descriptionMap,
                                 String xsd,
                                 ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException