@ProviderType public class PortletPreferencesLocalServiceUtil extends Object
com.liferay.portal.service.impl.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.PortletPreferencesLocalService
,
com.liferay.portal.service.base.PortletPreferencesLocalServiceBaseImpl
,
com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl
Constructor and Description |
---|
PortletPreferencesLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
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 PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
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 <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 PortletPreferences |
fetchPortletPreferences(long portletPreferencesId) |
static PortletPreferences |
fetchPreferences(long companyId,
long ownerId,
int ownerType,
long plid,
String portletId) |
static PortletPreferences |
fetchPreferences(PortletPreferencesIds portletPreferencesIds) |
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static PortletPreferences |
getDefaultPreferences(long companyId,
String portletId) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
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 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) |
public static ActionableDynamicQuery getActionableDynamicQuery()
public static DynamicQuery dynamicQuery()
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static PortletPreferences addPortletPreferences(PortletPreferences portletPreferences)
portletPreferences
- the portlet preferencespublic static PortletPreferences addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences)
public static PortletPreferences createPortletPreferences(long portletPreferencesId)
portletPreferencesId
- the primary key for the new portlet preferencespublic static PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences)
portletPreferences
- the portlet preferencespublic static PortletPreferences deletePortletPreferences(long portletPreferencesId) throws PortalException
portletPreferencesId
- the primary key of the portlet preferencesPortalException
- if a portlet preferences with the primary key could not be foundpublic static PortletPreferences fetchPortletPreferences(long portletPreferencesId)
public static PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException
PortalException
public static PortletPreferences getPortletPreferences(long portletPreferencesId) throws PortalException
portletPreferencesId
- the primary key of the portlet preferencesPortalException
- if a portlet preferences with the primary key could not be foundpublic static PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences)
portletPreferences
- the portlet preferencespublic static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml)
public static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences portletPreferences)
public static int getPortletPreferencesesCount()
public static String getOSGiServiceIdentifier()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.portal.model.impl.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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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 com.liferay.portal.model.impl.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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static List<PortletPreferences> getPortletPreferences()
public static List<PortletPreferences> getPortletPreferences(int ownerType, long plid, String portletId)
public static List<PortletPreferences> getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout)
public static List<PortletPreferences> getPortletPreferences(long ownerId, int ownerType, long plid)
public static List<PortletPreferences> getPortletPreferences(long plid, String portletId)
public static List<PortletPreferences> getPortletPreferencesByPlid(long plid)
public static List<PortletPreferences> getPortletPreferenceses(int start, int end)
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 com.liferay.portal.model.impl.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.
start
- the lower bound of the range of portlet preferencesesend
- the upper bound of the range of portlet preferenceses (not inclusive)public static PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds)
public static PortletPreferences fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
public static PortletPreferences getDefaultPreferences(long companyId, String portletId)
public static PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
public static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
public static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences)
public static PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
public static PortletPreferences getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static long getPortletPreferencesCount(int ownerType, String portletId)
public static long getPortletPreferencesCount(int ownerType, long plid, String portletId)
public static long getPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences)
public static long getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences)
public static void deletePortletPreferences(long ownerId, int ownerType, long plid)
public static void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException
PortalException
public static void deletePortletPreferencesByPlid(long plid)
public static PortletPreferencesLocalService getService()