com.liferay.portlet.dynamicdatamapping.service
Class DDMStructureLocalServiceUtil

java.lang.Object
  com.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalServiceUtil

public class DDMStructureLocalServiceUtil
extends Object

The utility for the d d m structure local service. This utility wraps com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl 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:

DDMStructureLocalService, com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl

Constructor Summary

DDMStructureLocalServiceUtil()

Method Summary

static DDMStructure	addDDMStructure(DDMStructure ddmStructure) Adds the d d m structure to the database.
static void	addDLFileEntryTypeDDMStructure(long fileEntryTypeId, DDMStructure ddmStructure)
static void	addDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
static void	addDLFileEntryTypeDDMStructures(long fileEntryTypeId, List<DDMStructure> DDMStructures)
static void	addDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
static DDMStructure	addStructure(long userId, long groupId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
static void	addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addStructureResources(DDMStructure structure, String[] groupPermissions, String[] guestPermissions)
static void	clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
static DDMStructure	copyStructure(long userId, long structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, ServiceContext serviceContext)
static DDMStructure	createDDMStructure(long structureId) Creates a new d d m structure with the primary key.
static DDMStructure	deleteDDMStructure(DDMStructure ddmStructure) Deletes the d d m structure from the database.
static DDMStructure	deleteDDMStructure(long structureId) Deletes the d d m structure with the primary key from the database.
static void	deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, DDMStructure ddmStructure)
static void	deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
static void	deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, List<DDMStructure> DDMStructures)
static void	deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
static void	deleteStructure(DDMStructure structure)
static void	deleteStructure(long structureId)
static void	deleteStructure(long groupId, String structureKey)
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 DDMStructure	fetchDDMStructure(long structureId)
static DDMStructure	fetchStructure(long structureId)
static DDMStructure	fetchStructure(long groupId, String structureKey)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<DDMStructure>	getClassStructures(long classNameId) Deprecated. getClassStructures(long, long)
static List<DDMStructure>	getClassStructures(long classNameId, int start, int end) Deprecated. getClassStructures(long, long, int, int)
static List<DDMStructure>	getClassStructures(long companyId, long classNameId)
static List<DDMStructure>	getClassStructures(long companyId, long classNameId, int start, int end)
static List<DDMStructure>	getClassStructures(long companyId, long classNameId, OrderByComparator orderByComparator)
static List<DDMStructure>	getClassStructures(long classNameId, OrderByComparator orderByComparator) Deprecated. getClassStructures(long, long, OrderByComparator)
static DDMStructure	getDDMStructure(long structureId) Returns the d d m structure with the primary key.
static DDMStructure	getDDMStructureByUuidAndGroupId(String uuid, long groupId) Returns the d d m structure with the UUID in the group.
static List<DDMStructure>	getDDMStructures(int start, int end) Returns a range of all the d d m structures.
static int	getDDMStructuresCount() Returns the number of d d m structures.
static List<DDMStructure>	getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
static List<DDMStructure>	getDLFileEntryTypeDDMStructures(long fileEntryTypeId, int start, int end)
static List<DDMStructure>	getDLFileEntryTypeDDMStructures(long fileEntryTypeId, int start, int end, OrderByComparator orderByComparator)
static int	getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
static List<DDMStructure>	getDLFileEntryTypeStructures(long dlFileEntryTypeId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DDMStructureLocalService	getService()
static DDMStructure	getStructure(long structureId)
static DDMStructure	getStructure(long groupId, String structureKey)
static List<DDMStructure>	getStructure(long groupId, String name, String description)
static List<DDMStructure>	getStructureEntries() Deprecated. getStructures()
static List<DDMStructure>	getStructureEntries(long groupId) Deprecated. getStructures(long)
static List<DDMStructure>	getStructureEntries(long groupId, int start, int end) Deprecated. getStructures(long, int, int)
static List<DDMStructure>	getStructures()
static List<DDMStructure>	getStructures(long groupId)
static List<DDMStructure>	getStructures(long groupId, int start, int end)
static int	getStructuresCount(long groupId)
static boolean	hasDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
static boolean	hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
static List<DDMStructure>	search(long companyId, long[] groupIds, long[] classNameIds, String keywords, int start, int end, OrderByComparator orderByComparator)
static List<DDMStructure>	search(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
static int	searchCount(long companyId, long[] groupIds, long[] classNameIds, String keywords)
static int	searchCount(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
static void	setDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
void	setService(DDMStructureLocalService service) Deprecated.
static DDMStructure	updateDDMStructure(DDMStructure ddmStructure) Updates the d d m structure in the database or adds it if it does not yet exist.
static DDMStructure	updateDDMStructure(DDMStructure ddmStructure, boolean merge) Updates the d d m structure in the database or adds it if it does not yet exist.
static DDMStructure	updateStructure(long structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
static DDMStructure	updateStructure(long groupId, String structureKey, 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

DDMStructureLocalServiceUtil

public DDMStructureLocalServiceUtil()

Method Detail

addDDMStructure

public static DDMStructure addDDMStructure(DDMStructure ddmStructure)
                                    throws SystemException

Adds the d d m structure to the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the d d m structure

Returns:

the d d m structure that was added

Throws:

SystemException - if a system exception occurred

createDDMStructure

public static DDMStructure createDDMStructure(long structureId)

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

Parameters:

structureId - the primary key for the new d d m structure

Returns:

the new d d m structure

deleteDDMStructure

public static DDMStructure deleteDDMStructure(long structureId)
                                       throws PortalException,
                                              SystemException

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

Parameters:

structureId - the primary key of the d d m structure

Returns:

the d d m structure that was removed

Throws:

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

SystemException - if a system exception occurred

deleteDDMStructure

public static DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
                                       throws SystemException

Deletes the d d m structure from the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the d d m structure

Returns:

the d d m 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

fetchDDMStructure

public static DDMStructure fetchDDMStructure(long structureId)
                                      throws SystemException

Throws:

SystemException

getDDMStructure

public static DDMStructure getDDMStructure(long structureId)
                                    throws PortalException,
                                           SystemException

Returns the d d m structure with the primary key.

Parameters:

structureId - the primary key of the d d m structure

Returns:

the d d m structure

Throws:

PortalException - if a d d m 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

getDDMStructureByUuidAndGroupId

public static DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
                                                           long groupId)
                                                    throws PortalException,
                                                           SystemException

Returns the d d m structure with the UUID in the group.

Parameters:

uuid - the UUID of d d m structure

groupId - the group id of the d d m structure

Returns:

the d d m structure

Throws:

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

SystemException - if a system exception occurred

getDDMStructures

public static List<DDMStructure> getDDMStructures(int start,
                                                  int end)
                                           throws SystemException

Returns a range of all the d d m 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 d d m structures

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

Returns:

the range of d d m structures

Throws:

SystemException - if a system exception occurred

getDDMStructuresCount

public static int getDDMStructuresCount()
                                 throws SystemException

Returns the number of d d m structures.

Returns:

the number of d d m structures

Throws:

SystemException - if a system exception occurred

updateDDMStructure

public static DDMStructure updateDDMStructure(DDMStructure ddmStructure)
                                       throws SystemException

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

Parameters:

ddmStructure - the d d m structure

Returns:

the d d m structure that was updated

Throws:

SystemException - if a system exception occurred

updateDDMStructure

public static DDMStructure updateDDMStructure(DDMStructure ddmStructure,
                                              boolean merge)
                                       throws SystemException

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

Parameters:

ddmStructure - the d d m structure

merge - whether to merge the d d m 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 d d m structure that was updated

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructure

public static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                  long structureId)
                                           throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructure

public static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                  DDMStructure ddmStructure)
                                           throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructures

public static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                   long[] structureIds)
                                            throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructures

public static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                   List<DDMStructure> DDMStructures)
                                            throws SystemException

Throws:

SystemException - if a system exception occurred

clearDLFileEntryTypeDDMStructures

public static void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
                                              throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructure

public static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                     long structureId)
                                              throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructure

public static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                     DDMStructure ddmStructure)
                                              throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructures

public static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                      long[] structureIds)
                                               throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructures

public static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                      List<DDMStructure> DDMStructures)
                                               throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructures

public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
                                                          throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructures

public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                                 int start,
                                                                 int end)
                                                          throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructures

public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator orderByComparator)
                                                          throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructuresCount

public static int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
                                                throws SystemException

Throws:

SystemException - if a system exception occurred

hasDLFileEntryTypeDDMStructure

public static boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                     long structureId)
                                              throws SystemException

Throws:

SystemException - if a system exception occurred

hasDLFileEntryTypeDDMStructures

public static boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
                                               throws SystemException

Throws:

SystemException - if a system exception occurred

setDLFileEntryTypeDDMStructures

public static void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                   long[] structureIds)
                                            throws SystemException

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 DDMStructure addStructure(long userId,
                                        long groupId,
                                        long classNameId,
                                        String structureKey,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        String xsd,
                                        String storageType,
                                        int type,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addStructureResources

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

Throws:

PortalException

SystemException

addStructureResources

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

Throws:

PortalException

SystemException

copyStructure

public static DDMStructure copyStructure(long userId,
                                         long structureId,
                                         Map<Locale,String> nameMap,
                                         Map<Locale,String> descriptionMap,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

deleteStructure

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

Throws:

PortalException

SystemException

deleteStructure

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

Throws:

PortalException

SystemException

deleteStructure

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

Throws:

PortalException

SystemException

deleteStructures

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

Throws:

PortalException

SystemException

fetchStructure

public static DDMStructure fetchStructure(long structureId)
                                   throws SystemException

Throws:

SystemException

fetchStructure

public static DDMStructure fetchStructure(long groupId,
                                          String structureKey)
                                   throws SystemException

Throws:

SystemException

getClassStructures

public static List<DDMStructure> getClassStructures(long classNameId)
                                             throws SystemException

Deprecated. getClassStructures(long, long)

Throws:

SystemException

getClassStructures

public static List<DDMStructure> getClassStructures(long classNameId,
                                                    int start,
                                                    int end)
                                             throws SystemException

Deprecated. getClassStructures(long, long, int, int)

Throws:

SystemException

getClassStructures

public static List<DDMStructure> getClassStructures(long companyId,
                                                    long classNameId)
                                             throws SystemException

Throws:

SystemException

getClassStructures

public static List<DDMStructure> getClassStructures(long companyId,
                                                    long classNameId,
                                                    int start,
                                                    int end)
                                             throws SystemException

Throws:

SystemException

getClassStructures

public static List<DDMStructure> getClassStructures(long companyId,
                                                    long classNameId,
                                                    OrderByComparator orderByComparator)
                                             throws SystemException

Throws:

SystemException

getClassStructures

public static List<DDMStructure> getClassStructures(long classNameId,
                                                    OrderByComparator orderByComparator)
                                             throws SystemException

Deprecated. getClassStructures(long, long, OrderByComparator)

Throws:

SystemException

getDLFileEntryTypeStructures

public static List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
                                                       throws SystemException

Throws:

SystemException

getStructure

public static DDMStructure getStructure(long structureId)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getStructure

public static DDMStructure getStructure(long groupId,
                                        String structureKey)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getStructure

public static List<DDMStructure> getStructure(long groupId,
                                              String name,
                                              String description)
                                       throws SystemException

Throws:

SystemException

getStructureEntries

public static List<DDMStructure> getStructureEntries()
                                              throws SystemException

Deprecated. getStructures()

Throws:

SystemException

getStructureEntries

public static List<DDMStructure> getStructureEntries(long groupId)
                                              throws SystemException

Deprecated. getStructures(long)

Throws:

SystemException

getStructureEntries

public static List<DDMStructure> getStructureEntries(long groupId,
                                                     int start,
                                                     int end)
                                              throws SystemException

Deprecated. getStructures(long, int, int)

Throws:

SystemException

getStructures

public static List<DDMStructure> getStructures()
                                        throws SystemException

Throws:

SystemException

getStructures

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

Throws:

SystemException

getStructures

public static List<DDMStructure> 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<DDMStructure> search(long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String keywords,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                 throws SystemException

Throws:

SystemException

search

public static List<DDMStructure> search(long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String name,
                                        String description,
                                        String storageType,
                                        int type,
                                        boolean andOperator,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                 throws SystemException

Throws:

SystemException

searchCount

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

Throws:

SystemException

searchCount

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

Throws:

SystemException

updateStructure

public static DDMStructure updateStructure(long structureId,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           String xsd,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

updateStructure

public static DDMStructure updateStructure(long groupId,
                                           String structureKey,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           String xsd,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getService

public static DDMStructureLocalService getService()

setService

public void setService(DDMStructureLocalService service)

Deprecated.