Liferay 6.0.5

com.liferay.portal.service
Interface PortletPreferencesLocalService

All Known Implementing Classes:
PortletPreferencesLocalServiceBaseImpl, PortletPreferencesLocalServiceImpl, PortletPreferencesLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PortletPreferencesLocalService

The interface for the portlet preferences local service.

Never modify or reference this interface directly. Always use PortletPreferencesLocalServiceUtil to access the portlet preferences local service. Add custom service methods to PortletPreferencesLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:
PortletPreferencesLocalServiceUtil, PortletPreferencesLocalServiceBaseImpl, PortletPreferencesLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 PortletPreferences addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences)
           
 PortletPreferences addPortletPreferences(PortletPreferences portletPreferences)
          Adds the portlet preferences to the database.
 PortletPreferences createPortletPreferences(long portletPreferencesId)
          Creates a new portlet preferences with the primary key.
 void deletePortletPreferences(long portletPreferencesId)
          Deletes the portlet preferences with the primary key from the database.
 void deletePortletPreferences(long ownerId, int ownerType, long plid)
           
 void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId)
           
 void deletePortletPreferences(PortletPreferences portletPreferences)
          Deletes the portlet preferences from the database.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 PortletPreferences getDefaultPreferences(long companyId, String portletId)
           
 List<PortletPreferences> getPortletPreferences()
           
 PortletPreferences getPortletPreferences(long portletPreferencesId)
          Gets the portlet preferences with the primary key.
 List<PortletPreferences> getPortletPreferences(long ownerId, int ownerType, long plid)
           
 PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId)
           
 List<PortletPreferences> getPortletPreferences(long plid, String portletId)
           
 List<PortletPreferences> getPortletPreferencesByPlid(long plid)
           
 List<PortletPreferences> getPortletPreferenceses(int start, int end)
          Gets a range of all the portlet preferenceses.
 int getPortletPreferencesesCount()
          Gets the number of portlet preferenceses.
 PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
           
 PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences)
           
 PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
           
 PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences)
          Updates the portlet preferences in the database.
 PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences, boolean merge)
          Updates the portlet preferences in the database.
 PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences preferences)
           
 PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml)
           
 

Method Detail

addPortletPreferences

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

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

createPortletPreferences

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

void 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 to delete
Throws:
PortalException - if a portlet preferences with the primary key could not be found
SystemException - if a system exception occurred

deletePortletPreferences

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

Parameters:
portletPreferences - the portlet preferences to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

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

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPortletPreferences(long portletPreferencesId)
                                         throws PortalException,
                                                SystemException
Gets the portlet preferences with the primary key.

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

getPortletPreferenceses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferenceses(int start,
                                                                                          int end)
                                                 throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of portlet preferenceses to return
end - the upper bound of the range of portlet preferenceses to return (not inclusive)
Returns:
the range of portlet preferenceses
Throws:
SystemException - if a system exception occurred

getPortletPreferencesesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletPreferencesesCount()
                                 throws SystemException
Gets the number of portlet preferenceses.

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

updatePortletPreferences

PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences)
                                            throws SystemException
Updates the portlet preferences in the database. Also notifies the appropriate model listeners.

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

updatePortletPreferences

PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences,
                                            boolean merge)
                                            throws SystemException
Updates the portlet preferences in the database. Also notifies the appropriate model listeners.

Parameters:
portletPreferences - the portlet preferences to update
merge - whether to merge the portlet preferences 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 portlet preferences that was updated
Throws:
SystemException - if a system exception occurred

addPortletPreferences

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

deletePortletPreferences

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

deletePortletPreferences

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

getDefaultPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getDefaultPreferences(long companyId,
                                                                                  String portletId)
                                         throws SystemException
Throws:
SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences()
                                               throws SystemException
Throws:
SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences(long plid,
                                                                                        String portletId)
                                               throws SystemException
Throws:
SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences(long ownerId,
                                                                                        int ownerType,
                                                                                        long plid)
                                               throws SystemException
Throws:
SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPortletPreferences(long ownerId,
                                                                                  int ownerType,
                                                                                  long plid,
                                                                                  String portletId)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getPortletPreferencesByPlid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferencesByPlid(long plid)
                                                     throws SystemException
Throws:
SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
                                  throws SystemException
Throws:
SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long companyId,
                                                                           long ownerId,
                                                                           int ownerType,
                                                                           long plid,
                                                                           String portletId)
                                  throws SystemException
Throws:
SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long companyId,
                                                                           long ownerId,
                                                                           int ownerType,
                                                                           long plid,
                                                                           String portletId,
                                                                           String defaultPreferences)
                                  throws SystemException
Throws:
SystemException

updatePreferences

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

updatePreferences

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

Liferay 6.0.5