|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface PortletPreferencesLocalService
The interface for the portlet preferences local service.
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.
PortletPreferencesLocalServiceUtil
,
PortletPreferencesLocalServiceBaseImpl
,
com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl
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. |
PortletPreferences |
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)
|
PortletPreferences |
deletePortletPreferences(PortletPreferences portletPreferences)
Deletes the portlet preferences from the database. |
DynamicQuery |
dynamicQuery()
|
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)
Returns the number of rows that match the dynamic query. |
PortletPreferences |
fetchPortletPreferences(long portletPreferencesId)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
PortletPreferences |
getDefaultPreferences(long companyId,
String portletId)
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
List<PortletPreferences> |
getPortletPreferences()
|
List<PortletPreferences> |
getPortletPreferences(int ownerType,
long plid,
String portletId)
|
PortletPreferences |
getPortletPreferences(long portletPreferencesId)
Returns 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 companyId,
long groupId,
long ownerId,
int ownerType,
String portletId,
boolean privateLayout)
|
List<PortletPreferences> |
getPortletPreferences(long plid,
String portletId)
|
List<PortletPreferences> |
getPortletPreferencesByPlid(long plid)
|
List<PortletPreferences> |
getPortletPreferenceses(int start,
int end)
Returns a range of all the portlet preferenceses. |
int |
getPortletPreferencesesCount()
Returns 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 |
getStrictPreferences(long companyId,
long ownerId,
int ownerType,
long plid,
String portletId)
|
PortletPreferences |
getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
PortletPreferences |
updatePortletPreferences(PortletPreferences portletPreferences)
Updates the portlet preferences in the database or adds it if it does not yet exist. |
PortletPreferences |
updatePortletPreferences(PortletPreferences portletPreferences,
boolean merge)
Updates the portlet preferences in the database or adds it if it does not yet exist. |
PortletPreferences |
updatePreferences(long ownerId,
int ownerType,
long plid,
String portletId,
PortletPreferences portletPreferences)
|
PortletPreferences |
updatePreferences(long ownerId,
int ownerType,
long plid,
String portletId,
String xml)
|
Method Detail |
---|
PortletPreferences addPortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences
SystemException
- if a system exception occurredPortletPreferences createPortletPreferences(long portletPreferencesId)
portletPreferencesId
- the primary key for the new portlet preferences
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 occurredPortletPreferences deletePortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences
SystemException
- if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredList 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 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 occurredList 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 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 occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences fetchPortletPreferences(long portletPreferencesId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) 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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) 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 preferencesesend
- the upper bound of the range of portlet preferenceses (not inclusive)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getPortletPreferencesesCount() throws SystemException
SystemException
- if a system exception occurredPortletPreferences updatePortletPreferences(PortletPreferences portletPreferences) throws SystemException
portletPreferences
- the portlet preferences
SystemException
- if a system exception occurredPortletPreferences updatePortletPreferences(PortletPreferences portletPreferences, boolean merge) throws SystemException
portletPreferences
- the portlet preferencesmerge
- 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 occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanPortletPreferences addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences) throws SystemException
SystemException
void deletePortletPreferences(long ownerId, int ownerType, long plid) throws SystemException
SystemException
void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getDefaultPreferences(long companyId, String portletId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferences> getPortletPreferences() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferences> getPortletPreferences(int ownerType, long plid, String portletId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferences> getPortletPreferences(long ownerId, int ownerType, long plid) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferences> getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferences> getPortletPreferences(long plid, String portletId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferences> getPortletPreferencesByPlid(long plid) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds) throws SystemException
SystemException
PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences portletPreferences) throws SystemException
SystemException
PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml) throws SystemException
SystemException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |