|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.PortletPreferencesLocalServiceUtil
public class PortletPreferencesLocalServiceUtil
The utility for the portlet preferences local service. This utility wraps PortletPreferencesLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
Never modify this class directly. Add custom service methods to PortletPreferencesLocalServiceImpl
and rerun ServiceBuilder to regenerate this class.
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.
PortletPreferencesLocalService
,
PortletPreferencesLocalServiceBaseImpl
,
PortletPreferencesLocalServiceImpl
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 void |
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 void |
deletePortletPreferences(PortletPreferences portletPreferences)
Deletes the portlet preferences from the database. |
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)
Counts the number of rows that match the dynamic query. |
static PortletPreferences |
getDefaultPreferences(long companyId,
String portletId)
|
static List<PortletPreferences> |
getPortletPreferences()
|
static PortletPreferences |
getPortletPreferences(long portletPreferencesId)
Gets 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 plid,
String portletId)
|
static List<PortletPreferences> |
getPortletPreferencesByPlid(long plid)
|
static List<PortletPreferences> |
getPortletPreferenceses(int start,
int end)
Gets a range of all the portlet preferenceses. |
static int |
getPortletPreferencesesCount()
Gets 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()
|
void |
setService(PortletPreferencesLocalService service)
|
static PortletPreferences |
updatePortletPreferences(PortletPreferences portletPreferences)
Updates the portlet preferences in the database. |
static PortletPreferences |
updatePortletPreferences(PortletPreferences portletPreferences,
boolean merge)
Updates the portlet preferences in the database. |
static PortletPreferences |
updatePreferences(long ownerId,
int ownerType,
long plid,
String portletId,
PortletPreferences preferences)
|
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 |
---|
public PortletPreferencesLocalServiceUtil()
Method Detail |
---|
public static PortletPreferences addPortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences to add
SystemException
- if a system exception occurredpublic static PortletPreferences createPortletPreferences(long portletPreferencesId)
portletPreferencesId
- the primary key for the new portlet preferences
public static void deletePortletPreferences(long portletPreferencesId) throws PortalException, SystemException
portletPreferencesId
- the primary key of the portlet preferences to delete
PortalException
- if a portlet preferences with the primary key could not be found
SystemException
- if a system exception occurredpublic static void deletePortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences to delete
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static PortletPreferences getPortletPreferences(long portletPreferencesId) throws PortalException, SystemException
portletPreferencesId
- the primary key of the portlet preferences to get
PortalException
- if a portlet preferences with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<PortletPreferences> getPortletPreferenceses(int start, int end) throws SystemException
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.
start
- the lower bound of the range of portlet preferenceses to returnend
- the upper bound of the range of portlet preferenceses to return (not inclusive)
SystemException
- if a system exception occurredpublic static int getPortletPreferencesesCount() throws SystemException
SystemException
- if a system exception occurredpublic static PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences to update
SystemException
- if a system exception occurredpublic static PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences, boolean merge) throws SystemException
portletPreferences
- the portlet preferences to updatemerge
- 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.
SystemException
- if a system exception occurredpublic static PortletPreferences addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences) throws SystemException
SystemException
public static void deletePortletPreferences(long ownerId, int ownerType, long plid) throws SystemException
SystemException
public static void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException, SystemException
PortalException
SystemException
public static PortletPreferences getDefaultPreferences(long companyId, String portletId) throws SystemException
SystemException
public static List<PortletPreferences> getPortletPreferences() throws SystemException
SystemException
public static List<PortletPreferences> getPortletPreferences(long plid, String portletId) throws SystemException
SystemException
public static List<PortletPreferences> getPortletPreferences(long ownerId, int ownerType, long plid) throws SystemException
SystemException
public static PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException, SystemException
PortalException
SystemException
public static List<PortletPreferences> getPortletPreferencesByPlid(long plid) throws SystemException
SystemException
public static PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds) throws SystemException
SystemException
public static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) throws SystemException
SystemException
public static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) throws SystemException
SystemException
public static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences preferences) throws SystemException
SystemException
public static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml) throws SystemException
SystemException
public static PortletPreferencesLocalService getService()
public void setService(PortletPreferencesLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |