com.liferay.exportimport.kernel.service

Class ExportImportConfigurationLocalServiceUtil

Object

com.liferay.exportimport.kernel.service.ExportImportConfigurationLocalServiceUtil

public class ExportImportConfigurationLocalServiceUtil
extends Object

Provides the local service utility for ExportImportConfiguration. This utility wraps com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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.

Author:

Brian Wing Shun Chan

See Also:

ExportImportConfigurationLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ExportImportConfigurationLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ExportImportConfiguration	addDraftExportImportConfiguration(long userId, int type, Map<String,Serializable> settingsMap) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
static ExportImportConfiguration	addDraftExportImportConfiguration(long userId, String name, int type, Map<String,Serializable> settingsMap)
static ExportImportConfiguration	addExportImportConfiguration(ExportImportConfiguration exportImportConfiguration) Adds the export import configuration to the database.
static ExportImportConfiguration	addExportImportConfiguration(long userId, long groupId, String name, String description, int type, Map<String,Serializable> settingsMap, int status, ServiceContext serviceContext)
static ExportImportConfiguration	addExportImportConfiguration(long userId, long groupId, String name, String description, int type, Map<String,Serializable> settingsMap, ServiceContext serviceContext)
static ExportImportConfiguration	createExportImportConfiguration(long exportImportConfigurationId) Creates a new export import configuration with the primary key.
static ExportImportConfiguration	deleteExportImportConfiguration(ExportImportConfiguration exportImportConfiguration) Deletes the export import configuration from the database.
static ExportImportConfiguration	deleteExportImportConfiguration(long exportImportConfigurationId) Deletes the export import configuration with the primary key from the database.
static void	deleteExportImportConfigurations(long groupId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static ExportImportConfiguration	fetchExportImportConfiguration(long exportImportConfigurationId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static ExportImportConfiguration	getExportImportConfiguration(long exportImportConfigurationId) Returns the export import configuration with the primary key.
static List<ExportImportConfiguration>	getExportImportConfigurations(Hits hits)
static List<ExportImportConfiguration>	getExportImportConfigurations(int start, int end) Returns a range of all the export import configurations.
static List<ExportImportConfiguration>	getExportImportConfigurations(long groupId, int type)
static List<ExportImportConfiguration>	getExportImportConfigurations(long groupId, int type, int start, int end, OrderByComparator<ExportImportConfiguration> orderByComparator)
static List<ExportImportConfiguration>	getExportImportConfigurations(long companyId, long groupId, String keywords, int type, int start, int end, OrderByComparator<ExportImportConfiguration> orderByComparator)
static List<ExportImportConfiguration>	getExportImportConfigurations(long companyId, long groupId, String name, String description, int type, boolean andSearch, int start, int end, OrderByComparator<ExportImportConfiguration> orderByComparator)
static int	getExportImportConfigurationsCount() Returns the number of export import configurations.
static int	getExportImportConfigurationsCount(long groupId)
static int	getExportImportConfigurationsCount(long groupId, int type)
static int	getExportImportConfigurationsCount(long companyId, long groupId, String keywords, int type)
static int	getExportImportConfigurationsCount(long companyId, long groupId, String name, String description, int type, boolean andSearch)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ExportImportConfigurationLocalService	getService()
static ExportImportConfiguration	moveExportImportConfigurationToTrash(long userId, long exportImportConfigurationId)
static ExportImportConfiguration	restoreExportImportConfigurationFromTrash(long userId, long exportImportConfigurationId)
static BaseModelSearchResult<ExportImportConfiguration>	searchExportImportConfigurations(long companyId, long groupId, int type, String keywords, int start, int end, Sort sort)
static BaseModelSearchResult<ExportImportConfiguration>	searchExportImportConfigurations(long companyId, long groupId, int type, String name, String description, boolean andSearch, int start, int end, Sort sort)
static ExportImportConfiguration	updateExportImportConfiguration(ExportImportConfiguration exportImportConfiguration) Updates the export import configuration in the database or adds it if it does not yet exist.
static ExportImportConfiguration	updateExportImportConfiguration(long userId, long exportImportConfigurationId, String name, String description, Map<String,Serializable> settingsMap, ServiceContext serviceContext)
static ExportImportConfiguration	updateStatus(long userId, long exportImportConfigurationId, int status)

Methods inherited from class Object

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

Constructor Detail

ExportImportConfigurationLocalServiceUtil

public ExportImportConfigurationLocalServiceUtil()

Method Detail

addDraftExportImportConfiguration

public static ExportImportConfiguration addDraftExportImportConfiguration(long userId,
                                                                          int type,
                                                                          Map<String,Serializable> settingsMap)
                                                                   throws PortalException

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use ExportImportConfigurationLocalServiceUtil to access the export import configuration local service. Add custom service methods to com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

addDraftExportImportConfiguration

public static ExportImportConfiguration addDraftExportImportConfiguration(long userId,
                                                                          String name,
                                                                          int type,
                                                                          Map<String,Serializable> settingsMap)
                                                                   throws PortalException

Throws:

PortalException

addExportImportConfiguration

public static ExportImportConfiguration addExportImportConfiguration(ExportImportConfiguration exportImportConfiguration)

Adds the export import configuration to the database. Also notifies the appropriate model listeners.

Parameters:

exportImportConfiguration - the export import configuration

Returns:

the export import configuration that was added

addExportImportConfiguration

public static ExportImportConfiguration addExportImportConfiguration(long userId,
                                                                     long groupId,
                                                                     String name,
                                                                     String description,
                                                                     int type,
                                                                     Map<String,Serializable> settingsMap,
                                                                     int status,
                                                                     ServiceContext serviceContext)
                                                              throws PortalException

Throws:

PortalException

addExportImportConfiguration

public static ExportImportConfiguration addExportImportConfiguration(long userId,
                                                                     long groupId,
                                                                     String name,
                                                                     String description,
                                                                     int type,
                                                                     Map<String,Serializable> settingsMap,
                                                                     ServiceContext serviceContext)
                                                              throws PortalException

Throws:

PortalException

createExportImportConfiguration

public static ExportImportConfiguration createExportImportConfiguration(long exportImportConfigurationId)

Creates a new export import configuration with the primary key. Does not add the export import configuration to the database.

Parameters:

exportImportConfigurationId - the primary key for the new export import configuration

Returns:

the new export import configuration

deleteExportImportConfiguration

public static ExportImportConfiguration deleteExportImportConfiguration(ExportImportConfiguration exportImportConfiguration)

Deletes the export import configuration from the database. Also notifies the appropriate model listeners.

Parameters:

exportImportConfiguration - the export import configuration

Returns:

the export import configuration that was removed

deleteExportImportConfiguration

public static ExportImportConfiguration deleteExportImportConfiguration(long exportImportConfigurationId)
                                                                 throws PortalException

Deletes the export import configuration with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

exportImportConfigurationId - the primary key of the export import configuration

Returns:

the export import configuration that was removed

Throws:

PortalException - if a export import configuration with the primary key could not be found

deleteExportImportConfigurations

public static void deleteExportImportConfigurations(long groupId)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.exportimport.model.impl.ExportImportConfigurationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.exportimport.model.impl.ExportImportConfigurationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchExportImportConfiguration

public static ExportImportConfiguration fetchExportImportConfiguration(long exportImportConfigurationId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportImportConfiguration

public static ExportImportConfiguration getExportImportConfiguration(long exportImportConfigurationId)
                                                              throws PortalException

Returns the export import configuration with the primary key.

Parameters:

exportImportConfigurationId - the primary key of the export import configuration

Returns:

the export import configuration

Throws:

PortalException - if a export import configuration with the primary key could not be found

getExportImportConfigurations

public static List<ExportImportConfiguration> getExportImportConfigurations(Hits hits)
                                                                     throws PortalException

Throws:

PortalException

getExportImportConfigurations

public static List<ExportImportConfiguration> getExportImportConfigurations(int start,
                                                                            int end)

Returns a range of all the export import configurations.

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.exportimport.model.impl.ExportImportConfigurationModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of export import configurations

end - the upper bound of the range of export import configurations (not inclusive)

Returns:

the range of export import configurations

getExportImportConfigurations

public static List<ExportImportConfiguration> getExportImportConfigurations(long groupId,
                                                                            int type)

getExportImportConfigurations

public static List<ExportImportConfiguration> getExportImportConfigurations(long groupId,
                                                                            int type,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator<ExportImportConfiguration> orderByComparator)

getExportImportConfigurations

public static List<ExportImportConfiguration> getExportImportConfigurations(long companyId,
                                                                            long groupId,
                                                                            String keywords,
                                                                            int type,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator<ExportImportConfiguration> orderByComparator)

getExportImportConfigurations

public static List<ExportImportConfiguration> getExportImportConfigurations(long companyId,
                                                                            long groupId,
                                                                            String name,
                                                                            String description,
                                                                            int type,
                                                                            boolean andSearch,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator<ExportImportConfiguration> orderByComparator)

getExportImportConfigurationsCount

public static int getExportImportConfigurationsCount()

Returns the number of export import configurations.

Returns:

the number of export import configurations

getExportImportConfigurationsCount

public static int getExportImportConfigurationsCount(long groupId)

getExportImportConfigurationsCount

public static int getExportImportConfigurationsCount(long groupId,
                                                     int type)

getExportImportConfigurationsCount

public static int getExportImportConfigurationsCount(long companyId,
                                                     long groupId,
                                                     String keywords,
                                                     int type)

getExportImportConfigurationsCount

public static int getExportImportConfigurationsCount(long companyId,
                                                     long groupId,
                                                     String name,
                                                     String description,
                                                     int type,
                                                     boolean andSearch)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

moveExportImportConfigurationToTrash

public static ExportImportConfiguration moveExportImportConfigurationToTrash(long userId,
                                                                             long exportImportConfigurationId)
                                                                      throws PortalException

Throws:

PortalException

restoreExportImportConfigurationFromTrash

public static ExportImportConfiguration restoreExportImportConfigurationFromTrash(long userId,
                                                                                  long exportImportConfigurationId)
                                                                           throws PortalException

Throws:

PortalException

searchExportImportConfigurations

public static BaseModelSearchResult<ExportImportConfiguration> searchExportImportConfigurations(long companyId,
                                                                                                long groupId,
                                                                                                int type,
                                                                                                String keywords,
                                                                                                int start,
                                                                                                int end,
                                                                                                Sort sort)
                                                                                         throws PortalException

Throws:

PortalException

searchExportImportConfigurations

public static BaseModelSearchResult<ExportImportConfiguration> searchExportImportConfigurations(long companyId,
                                                                                                long groupId,
                                                                                                int type,
                                                                                                String name,
                                                                                                String description,
                                                                                                boolean andSearch,
                                                                                                int start,
                                                                                                int end,
                                                                                                Sort sort)
                                                                                         throws PortalException

Throws:

PortalException

updateExportImportConfiguration

public static ExportImportConfiguration updateExportImportConfiguration(ExportImportConfiguration exportImportConfiguration)

Updates the export import configuration in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

exportImportConfiguration - the export import configuration

Returns:

the export import configuration that was updated

updateExportImportConfiguration

public static ExportImportConfiguration updateExportImportConfiguration(long userId,
                                                                        long exportImportConfigurationId,
                                                                        String name,
                                                                        String description,
                                                                        Map<String,Serializable> settingsMap,
                                                                        ServiceContext serviceContext)
                                                                 throws PortalException

Throws:

PortalException

updateStatus

public static ExportImportConfiguration updateStatus(long userId,
                                                     long exportImportConfigurationId,
                                                     int status)
                                              throws PortalException

Throws:

PortalException

getService

public static ExportImportConfigurationLocalService getService()