Liferay 6.2-ce-ga5

com.liferay.portal.service
Class PluginSettingLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.PluginSettingLocalServiceUtil

@ProviderType
public class PluginSettingLocalServiceUtil
extends Object

Provides the local service utility for PluginSetting. This utility wraps PluginSettingLocalServiceImpl and is the primary 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.

See Also:
PluginSettingLocalService, PluginSettingLocalServiceBaseImpl, PluginSettingLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
PluginSettingLocalServiceUtil()
           
 
Method Summary
static PluginSetting addPluginSetting(PluginSetting pluginSetting)
          Adds the plugin setting to the database.
static void checkPermission(long userId, String pluginId, String pluginType)
           
static PluginSetting createPluginSetting(long pluginSettingId)
          Creates a new plugin setting with the primary key.
static PluginSetting deletePluginSetting(long pluginSettingId)
          Deletes the plugin setting with the primary key from the database.
static PluginSetting deletePluginSetting(PluginSetting pluginSetting)
          Deletes the plugin setting from the database.
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 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static PluginSetting fetchPluginSetting(long pluginSettingId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PluginSetting getDefaultPluginSetting()
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static PluginSetting getPluginSetting(long pluginSettingId)
          Returns the plugin setting with the primary key.
static PluginSetting getPluginSetting(long companyId, String pluginId, String pluginType)
           
static List<PluginSetting> getPluginSettings(int start, int end)
          Returns a range of all the plugin settings.
static int getPluginSettingsCount()
          Returns the number of plugin settings.
static PluginSettingLocalService getService()
           
static boolean hasPermission(long userId, String pluginId, String pluginType)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(PluginSettingLocalService service)
          Deprecated. As of 6.2.0
static PluginSetting updatePluginSetting(long companyId, String pluginId, String pluginType, String roles, boolean active)
           
static PluginSetting updatePluginSetting(PluginSetting pluginSetting)
          Updates the plugin setting in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginSettingLocalServiceUtil

public PluginSettingLocalServiceUtil()
Method Detail

addPluginSetting

public static PluginSetting addPluginSetting(PluginSetting pluginSetting)
                                      throws SystemException
Adds the plugin setting to the database. Also notifies the appropriate model listeners.

Parameters:
pluginSetting - the plugin setting
Returns:
the plugin setting that was added
Throws:
SystemException - if a system exception occurred

createPluginSetting

public static PluginSetting createPluginSetting(long pluginSettingId)
Creates a new plugin setting with the primary key. Does not add the plugin setting to the database.

Parameters:
pluginSettingId - the primary key for the new plugin setting
Returns:
the new plugin setting

deletePluginSetting

public static PluginSetting deletePluginSetting(long pluginSettingId)
                                         throws PortalException,
                                                SystemException
Deletes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
pluginSettingId - the primary key of the plugin setting
Returns:
the plugin setting that was removed
Throws:
PortalException - if a plugin setting with the primary key could not be found
SystemException - if a system exception occurred

deletePluginSetting

public static PluginSetting deletePluginSetting(PluginSetting pluginSetting)
                                         throws SystemException
Deletes the plugin setting from the database. Also notifies the appropriate model listeners.

Parameters:
pluginSetting - the plugin setting
Returns:
the plugin setting 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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PluginSettingModelImpl. 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
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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PluginSettingModelImpl. 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
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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchPluginSetting

public static PluginSetting fetchPluginSetting(long pluginSettingId)
                                        throws SystemException
Throws:
SystemException

getPluginSetting

public static PluginSetting getPluginSetting(long pluginSettingId)
                                      throws PortalException,
                                             SystemException
Returns the plugin setting with the primary key.

Parameters:
pluginSettingId - the primary key of the plugin setting
Returns:
the plugin setting
Throws:
PortalException - if a plugin setting 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

getPluginSettings

public static List<PluginSetting> getPluginSettings(int start,
                                                    int end)
                                             throws SystemException
Returns a range of all the plugin settings.

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PluginSettingModelImpl. 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 plugin settings
end - the upper bound of the range of plugin settings (not inclusive)
Returns:
the range of plugin settings
Throws:
SystemException - if a system exception occurred

getPluginSettingsCount

public static int getPluginSettingsCount()
                                  throws SystemException
Returns the number of plugin settings.

Returns:
the number of plugin settings
Throws:
SystemException - if a system exception occurred

updatePluginSetting

public static PluginSetting updatePluginSetting(PluginSetting pluginSetting)
                                         throws SystemException
Updates the plugin setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
pluginSetting - the plugin setting
Returns:
the plugin setting 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

checkPermission

public static void checkPermission(long userId,
                                   String pluginId,
                                   String pluginType)
                            throws PortalException
Throws:
PortalException

getDefaultPluginSetting

public static PluginSetting getDefaultPluginSetting()

getPluginSetting

public static PluginSetting getPluginSetting(long companyId,
                                             String pluginId,
                                             String pluginType)
                                      throws SystemException
Throws:
SystemException

hasPermission

public static boolean hasPermission(long userId,
                                    String pluginId,
                                    String pluginType)

updatePluginSetting

public static PluginSetting updatePluginSetting(long companyId,
                                                String pluginId,
                                                String pluginType,
                                                String roles,
                                                boolean active)
                                         throws SystemException
Throws:
SystemException

getService

public static PluginSettingLocalService getService()

setService

public void setService(PluginSettingLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5