|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.PortletPreferencesLocalServiceUtil
@ProviderType public class PortletPreferencesLocalServiceUtil
Provides the local service utility for PortletPreferences. This utility wraps
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
,
PortletPreferencesLocalServiceBaseImpl
,
com.liferay.portal.service.impl.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 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 |
---|
public PortletPreferencesLocalServiceUtil()
Method Detail |
---|
public static PortletPreferences addPortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences
SystemException
- if a system exception occurredpublic static PortletPreferences createPortletPreferences(long portletPreferencesId)
portletPreferencesId
- the primary key for the new portlet preferences
public static PortletPreferences deletePortletPreferences(long portletPreferencesId) throws PortalException, SystemException
portletPreferencesId
- the primary key of the portlet preferences
PortalException
- if a portlet preferences with the primary key could not be found
SystemException
- if a system exception occurredpublic static PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
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. 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (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. 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.
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
)
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurredpublic static PortletPreferences fetchPortletPreferences(long portletPreferencesId) throws SystemException
SystemException
public static PortletPreferences getPortletPreferences(long portletPreferencesId) throws PortalException, SystemException
portletPreferencesId
- the primary key of the portlet preferences
PortalException
- if a portlet preferences with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public 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. 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.
start
- the lower bound of the range of portlet preferencesesend
- the upper bound of the range of portlet preferenceses (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
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic 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 void deletePortletPreferencesByPlid(long plid) throws SystemException
SystemException
public static PortletPreferences fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) throws SystemException
SystemException
public static PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds) throws SystemException
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(int ownerType, 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> getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) throws SystemException
SystemException
public static List<PortletPreferences> getPortletPreferences(long plid, String portletId) throws SystemException
SystemException
public static List<PortletPreferences> getPortletPreferencesByPlid(long plid) throws SystemException
SystemException
public static long getPortletPreferencesCount(int ownerType, long plid, String portletId) throws SystemException
SystemException
public static long getPortletPreferencesCount(int ownerType, String portletId) throws SystemException
SystemException
public static long getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences) throws SystemException
SystemException
public static long getPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences) 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 getPreferences(PortletPreferencesIds portletPreferencesIds) throws SystemException
SystemException
public static PortletPreferences getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) throws SystemException
SystemException
public static PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds) throws SystemException
SystemException
public static PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences portletPreferences) 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.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |