Liferay 6.2-ce-ga5

com.liferay.portal.service
Class PortletPreferencesLocalServiceUtil

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

@ProviderType
public class PortletPreferencesLocalServiceUtil
extends Object

Provides the local service utility for PortletPreferences. This utility wraps PortletPreferencesLocalServiceImpl 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:
PortletPreferencesLocalService, PortletPreferencesLocalServiceBaseImpl, PortletPreferencesLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
PortletPreferencesLocalServiceUtil()
           
 
Method Summary
static PortletPreferences addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences)
           
static PortletPreferences addPortletPreferences(PortletPreferences portletPreferences)
          Adds the portlet preferences to the database.
static PortletPreferences createPortletPreferences(long portletPreferencesId)
          Creates a new portlet preferences with the primary key.
static PortletPreferences deletePortletPreferences(long portletPreferencesId)
          Deletes the portlet preferences with the primary key from the database.
static void deletePortletPreferences(long ownerId, int ownerType, long plid)
           
static void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId)
           
static PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences)
          Deletes the portlet preferences from the database.
static void deletePortletPreferencesByPlid(long plid)
           
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 PortletPreferences fetchPortletPreferences(long portletPreferencesId)
           
static PortletPreferences fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
           
static PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PortletPreferences getDefaultPreferences(long companyId, String portletId)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static List<PortletPreferences> getPortletPreferences()
           
static List<PortletPreferences> getPortletPreferences(int ownerType, long plid, String portletId)
           
static PortletPreferences getPortletPreferences(long portletPreferencesId)
          Returns the portlet preferences with the primary key.
static List<PortletPreferences> getPortletPreferences(long ownerId, int ownerType, long plid)
           
static PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId)
           
static List<PortletPreferences> getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout)
           
static List<PortletPreferences> getPortletPreferences(long plid, String portletId)
           
static List<PortletPreferences> getPortletPreferencesByPlid(long plid)
           
static long getPortletPreferencesCount(int ownerType, long plid, String portletId)
           
static long getPortletPreferencesCount(int ownerType, String portletId)
           
static long getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences)
           
static long getPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences)
           
static List<PortletPreferences> getPortletPreferenceses(int start, int end)
          Returns a range of all the portlet preferenceses.
static int getPortletPreferencesesCount()
          Returns the number of portlet preferenceses.
static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
           
static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences)
           
static PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
           
static PortletPreferencesLocalService getService()
           
static PortletPreferences getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
           
static PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(PortletPreferencesLocalService service)
          Deprecated. As of 6.2.0
static PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences)
          Updates the portlet preferences in the database or adds it if it does not yet exist.
static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences portletPreferences)
           
static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletPreferencesLocalServiceUtil

public PortletPreferencesLocalServiceUtil()
Method Detail

addPortletPreferences

public static PortletPreferences addPortletPreferences(PortletPreferences portletPreferences)
                                                throws SystemException
Adds the portlet preferences to the database. Also notifies the appropriate model listeners.

Parameters:
portletPreferences - the portlet preferences
Returns:
the portlet preferences that was added
Throws:
SystemException - if a system exception occurred

createPortletPreferences

public static PortletPreferences createPortletPreferences(long portletPreferencesId)
Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.

Parameters:
portletPreferencesId - the primary key for the new portlet preferences
Returns:
the new portlet preferences

deletePortletPreferences

public static PortletPreferences deletePortletPreferences(long portletPreferencesId)
                                                   throws PortalException,
                                                          SystemException
Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.

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

deletePortletPreferences

public static PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences)
                                                   throws SystemException
Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.

Parameters:
portletPreferences - the portlet preferences
Returns:
the portlet preferences 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 PortletPreferencesModelImpl. 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 PortletPreferencesModelImpl. 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

fetchPortletPreferences

public static PortletPreferences fetchPortletPreferences(long portletPreferencesId)
                                                  throws SystemException
Throws:
SystemException

getPortletPreferences

public static PortletPreferences getPortletPreferences(long portletPreferencesId)
                                                throws PortalException,
                                                       SystemException
Returns the portlet preferences with the primary key.

Parameters:
portletPreferencesId - the primary key of the portlet preferences
Returns:
the portlet preferences
Throws:
PortalException - if a portlet preferences 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

getPortletPreferenceses

public static List<PortletPreferences> getPortletPreferenceses(int start,
                                                               int end)
                                                        throws SystemException
Returns a range of all the portlet preferenceses.

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 PortletPreferencesModelImpl. 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 portlet preferenceses
end - the upper bound of the range of portlet preferenceses (not inclusive)
Returns:
the range of portlet preferenceses
Throws:
SystemException - if a system exception occurred

getPortletPreferencesesCount

public static int getPortletPreferencesesCount()
                                        throws SystemException
Returns the number of portlet preferenceses.

Returns:
the number of portlet preferenceses
Throws:
SystemException - if a system exception occurred

updatePortletPreferences

public static PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences)
                                                   throws SystemException
Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
portletPreferences - the portlet preferences
Returns:
the portlet preferences 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

addPortletPreferences

public static PortletPreferences addPortletPreferences(long companyId,
                                                       long ownerId,
                                                       int ownerType,
                                                       long plid,
                                                       String portletId,
                                                       Portlet portlet,
                                                       String defaultPreferences)
                                                throws SystemException
Throws:
SystemException

deletePortletPreferences

public static void deletePortletPreferences(long ownerId,
                                            int ownerType,
                                            long plid)
                                     throws SystemException
Throws:
SystemException

deletePortletPreferences

public static void deletePortletPreferences(long ownerId,
                                            int ownerType,
                                            long plid,
                                            String portletId)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

deletePortletPreferencesByPlid

public static void deletePortletPreferencesByPlid(long plid)
                                           throws SystemException
Throws:
SystemException

fetchPreferences

public static PortletPreferences fetchPreferences(long companyId,
                                                  long ownerId,
                                                  int ownerType,
                                                  long plid,
                                                  String portletId)
                                           throws SystemException
Throws:
SystemException

fetchPreferences

public static PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds)
                                           throws SystemException
Throws:
SystemException

getDefaultPreferences

public static PortletPreferences getDefaultPreferences(long companyId,
                                                       String portletId)
                                                throws SystemException
Throws:
SystemException

getPortletPreferences

public static List<PortletPreferences> getPortletPreferences()
                                                      throws SystemException
Throws:
SystemException

getPortletPreferences

public static List<PortletPreferences> getPortletPreferences(int ownerType,
                                                             long plid,
                                                             String portletId)
                                                      throws SystemException
Throws:
SystemException

getPortletPreferences

public static List<PortletPreferences> getPortletPreferences(long ownerId,
                                                             int ownerType,
                                                             long plid)
                                                      throws SystemException
Throws:
SystemException

getPortletPreferences

public static PortletPreferences getPortletPreferences(long ownerId,
                                                       int ownerType,
                                                       long plid,
                                                       String portletId)
                                                throws PortalException,
                                                       SystemException
Throws:
PortalException
SystemException

getPortletPreferences

public static List<PortletPreferences> getPortletPreferences(long companyId,
                                                             long groupId,
                                                             long ownerId,
                                                             int ownerType,
                                                             String portletId,
                                                             boolean privateLayout)
                                                      throws SystemException
Throws:
SystemException

getPortletPreferences

public static List<PortletPreferences> getPortletPreferences(long plid,
                                                             String portletId)
                                                      throws SystemException
Throws:
SystemException

getPortletPreferencesByPlid

public static List<PortletPreferences> getPortletPreferencesByPlid(long plid)
                                                            throws SystemException
Throws:
SystemException

getPortletPreferencesCount

public static long getPortletPreferencesCount(int ownerType,
                                              long plid,
                                              String portletId)
                                       throws SystemException
Throws:
SystemException

getPortletPreferencesCount

public static long getPortletPreferencesCount(int ownerType,
                                              String portletId)
                                       throws SystemException
Throws:
SystemException

getPortletPreferencesCount

public static long getPortletPreferencesCount(long ownerId,
                                              int ownerType,
                                              long plid,
                                              Portlet portlet,
                                              boolean excludeDefaultPreferences)
                                       throws SystemException
Throws:
SystemException

getPortletPreferencesCount

public static long getPortletPreferencesCount(long ownerId,
                                              int ownerType,
                                              String portletId,
                                              boolean excludeDefaultPreferences)
                                       throws SystemException
Throws:
SystemException

getPreferences

public static PortletPreferences getPreferences(long companyId,
                                                long ownerId,
                                                int ownerType,
                                                long plid,
                                                String portletId)
                                         throws SystemException
Throws:
SystemException

getPreferences

public static PortletPreferences getPreferences(long companyId,
                                                long ownerId,
                                                int ownerType,
                                                long plid,
                                                String portletId,
                                                String defaultPreferences)
                                         throws SystemException
Throws:
SystemException

getPreferences

public static PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
                                         throws SystemException
Throws:
SystemException

getStrictPreferences

public static PortletPreferences getStrictPreferences(long companyId,
                                                      long ownerId,
                                                      int ownerType,
                                                      long plid,
                                                      String portletId)
                                               throws SystemException
Throws:
SystemException

getStrictPreferences

public static PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
                                               throws SystemException
Throws:
SystemException

updatePreferences

public static PortletPreferences updatePreferences(long ownerId,
                                                   int ownerType,
                                                   long plid,
                                                   String portletId,
                                                   PortletPreferences portletPreferences)
                                            throws SystemException
Throws:
SystemException

updatePreferences

public static PortletPreferences updatePreferences(long ownerId,
                                                   int ownerType,
                                                   long plid,
                                                   String portletId,
                                                   String xml)
                                            throws SystemException
Throws:
SystemException

getService

public static PortletPreferencesLocalService getService()

setService

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


Liferay 6.2-ce-ga5