com.liferay.portlet.journal.service
Class JournalStructureLocalServiceUtil

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

public class JournalStructureLocalServiceUtil
extends Object

The utility for the journal structure local service. This utility wraps com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl 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:

JournalStructureLocalService, com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl

Constructor Summary

JournalStructureLocalServiceUtil()

Method Summary

static JournalStructure	addJournalStructure(JournalStructure journalStructure) Adds the journal structure to the database.
static JournalStructure	addStructure(long userId, long groupId, String structureId, boolean autoStructureId, String parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
static void	addStructureResources(JournalStructure structure, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addStructureResources(JournalStructure structure, String[] groupPermissions, String[] guestPermissions)
static void	addStructureResources(long groupId, String structureId, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addStructureResources(long groupId, String structureId, String[] groupPermissions, String[] guestPermissions)
static void	checkNewLine(long groupId, String structureId)
static JournalStructure	copyStructure(long userId, long groupId, String oldStructureId, String newStructureId, boolean autoStructureId)
static JournalStructure	createJournalStructure(long id) Creates a new journal structure with the primary key.
static JournalStructure	deleteJournalStructure(JournalStructure journalStructure) Deletes the journal structure from the database.
static JournalStructure	deleteJournalStructure(long id) Deletes the journal structure with the primary key from the database.
static void	deleteStructure(JournalStructure structure)
static void	deleteStructure(long groupId, String structureId)
static void	deleteStructures(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 JournalStructure	fetchJournalStructure(long id)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static JournalStructure	getJournalStructure(long id) Returns the journal structure with the primary key.
static JournalStructure	getJournalStructureByUuidAndGroupId(String uuid, long groupId) Returns the journal structure with the UUID in the group.
static List<JournalStructure>	getJournalStructures(int start, int end) Returns a range of all the journal structures.
static int	getJournalStructuresCount() Returns the number of journal structures.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static JournalStructureLocalService	getService()
static JournalStructure	getStructure(long id)
static JournalStructure	getStructure(long groupId, String structureId)
static JournalStructure	getStructure(long groupId, String structureId, boolean includeGlobalStructures)
static List<JournalStructure>	getStructures()
static List<JournalStructure>	getStructures(long groupId)
static List<JournalStructure>	getStructures(long groupId, int start, int end)
static int	getStructuresCount(long groupId)
static List<JournalStructure>	search(long companyId, long[] groupIds, String keywords, int start, int end, OrderByComparator obc)
static List<JournalStructure>	search(long companyId, long[] groupIds, String structureId, String name, String description, boolean andOperator, int start, int end, OrderByComparator obc)
static int	searchCount(long companyId, long[] groupIds, String keywords)
static int	searchCount(long companyId, long[] groupIds, String structureId, String name, String description, boolean andOperator)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(JournalStructureLocalService service) Deprecated.
static JournalStructure	updateJournalStructure(JournalStructure journalStructure) Updates the journal structure in the database or adds it if it does not yet exist.
static JournalStructure	updateJournalStructure(JournalStructure journalStructure, boolean merge) Updates the journal structure in the database or adds it if it does not yet exist.
static JournalStructure	updateStructure(long groupId, String structureId, String parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalStructureLocalServiceUtil

public JournalStructureLocalServiceUtil()

Method Detail

addJournalStructure

public static JournalStructure addJournalStructure(JournalStructure journalStructure)
                                            throws SystemException

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

Parameters:

journalStructure - the journal structure

Returns:

the journal structure that was added

Throws:

SystemException - if a system exception occurred

createJournalStructure

public static JournalStructure createJournalStructure(long id)

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

Parameters:

id - the primary key for the new journal structure

Returns:

the new journal structure

deleteJournalStructure

public static JournalStructure deleteJournalStructure(long id)
                                               throws PortalException,
                                                      SystemException

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

Parameters:

id - the primary key of the journal structure

Returns:

the journal structure that was removed

Throws:

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

SystemException - if a system exception occurred

deleteJournalStructure

public static JournalStructure deleteJournalStructure(JournalStructure journalStructure)
                                               throws SystemException

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

Parameters:

journalStructure - the journal structure

Returns:

the journal structure 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

fetchJournalStructure

public static JournalStructure fetchJournalStructure(long id)
                                              throws SystemException

Throws:

SystemException

getJournalStructure

public static JournalStructure getJournalStructure(long id)
                                            throws PortalException,
                                                   SystemException

Returns the journal structure with the primary key.

Parameters:

id - the primary key of the journal structure

Returns:

the journal structure

Throws:

PortalException - if a journal structure 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

getJournalStructureByUuidAndGroupId

public static JournalStructure getJournalStructureByUuidAndGroupId(String uuid,
                                                                   long groupId)
                                                            throws PortalException,
                                                                   SystemException

Returns the journal structure with the UUID in the group.

Parameters:

uuid - the UUID of journal structure

groupId - the group id of the journal structure

Returns:

the journal structure

Throws:

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

SystemException - if a system exception occurred

getJournalStructures

public static List<JournalStructure> getJournalStructures(int start,
                                                          int end)
                                                   throws SystemException

Returns a range of all the journal structures.

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 structures

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

Returns:

the range of journal structures

Throws:

SystemException - if a system exception occurred

getJournalStructuresCount

public static int getJournalStructuresCount()
                                     throws SystemException

Returns the number of journal structures.

Returns:

the number of journal structures

Throws:

SystemException - if a system exception occurred

updateJournalStructure

public static JournalStructure updateJournalStructure(JournalStructure journalStructure)
                                               throws SystemException

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

Parameters:

journalStructure - the journal structure

Returns:

the journal structure that was updated

Throws:

SystemException - if a system exception occurred

updateJournalStructure

public static JournalStructure updateJournalStructure(JournalStructure journalStructure,
                                                      boolean merge)
                                               throws SystemException

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

Parameters:

journalStructure - the journal structure

merge - whether to merge the journal structure 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 structure 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

addStructure

public static JournalStructure addStructure(long userId,
                                            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

addStructureResources

public static void addStructureResources(JournalStructure structure,
                                         boolean addGroupPermissions,
                                         boolean addGuestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addStructureResources

public static void addStructureResources(JournalStructure structure,
                                         String[] groupPermissions,
                                         String[] guestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addStructureResources

public static void addStructureResources(long groupId,
                                         String structureId,
                                         boolean addGroupPermissions,
                                         boolean addGuestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addStructureResources

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

Throws:

PortalException

SystemException

checkNewLine

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

Throws:

PortalException

SystemException

copyStructure

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

Throws:

PortalException

SystemException

deleteStructure

public static void deleteStructure(JournalStructure structure)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteStructure

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

Throws:

PortalException

SystemException

deleteStructures

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

Throws:

PortalException

SystemException

getStructure

public static JournalStructure getStructure(long id)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

getStructure

public static JournalStructure getStructure(long groupId,
                                            String structureId)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

getStructure

public static JournalStructure getStructure(long groupId,
                                            String structureId,
                                            boolean includeGlobalStructures)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

getStructures

public static List<JournalStructure> getStructures()
                                            throws SystemException

Throws:

SystemException

getStructures

public static List<JournalStructure> getStructures(long groupId)
                                            throws SystemException

Throws:

SystemException

getStructures

public static List<JournalStructure> getStructures(long groupId,
                                                   int start,
                                                   int end)
                                            throws SystemException

Throws:

SystemException

getStructuresCount

public static int getStructuresCount(long groupId)
                              throws SystemException

Throws:

SystemException

search

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

Throws:

SystemException

search

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

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

Throws:

SystemException

searchCount

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

Throws:

SystemException

updateStructure

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

getService

public static JournalStructureLocalService getService()

setService

public void setService(JournalStructureLocalService service)

Deprecated.