|
Liferay 6.0.5 | |||||||||
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 LayoutLocalService
The interface for the layout local service.
Never modify or reference this interface directly. Always use LayoutLocalServiceUtil
to access the layout local service. Add custom service methods to LayoutLocalServiceImpl
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.
LayoutLocalServiceUtil
,
LayoutLocalServiceBaseImpl
,
LayoutLocalServiceImpl
Method Summary | |
---|---|
Layout |
addLayout(Layout layout)
Adds the layout to the database. |
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
String description,
String type,
boolean hidden,
String friendlyURL,
long dlFolderId,
ServiceContext serviceContext)
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
long dlFolderId,
ServiceContext serviceContext)
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
|
Layout |
createLayout(long plid)
Creates a new layout with the primary key. |
void |
deleteLayout(Layout layout)
Deletes the layout from the database. |
void |
deleteLayout(Layout layout,
boolean updateLayoutSet)
|
void |
deleteLayout(long plid)
Deletes the layout with the primary key from the database. |
void |
deleteLayout(long groupId,
boolean privateLayout,
long layoutId)
|
void |
deleteLayouts(long groupId,
boolean privateLayout)
|
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. |
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
byte[] |
exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
byte[] |
exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
File |
exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
long |
getDefaultPlid(long groupId)
|
long |
getDefaultPlid(long groupId,
boolean privateLayout)
|
long |
getDefaultPlid(long groupId,
boolean privateLayout,
String portletId)
|
Layout |
getDLFolderLayout(long dlFolderId)
|
Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
|
Layout |
getLayout(long plid)
Gets the layout with the primary key. |
Layout |
getLayout(long groupId,
boolean privateLayout,
long layoutId)
|
Layout |
getLayoutByIconImageId(long iconImageId)
|
Layout |
getLayoutByUuidAndGroupId(String uuid,
long groupId)
Gets the layout with the UUID and group id. |
List<Layout> |
getLayouts(int start,
int end)
Gets a range of all the layouts. |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout)
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
int start,
int end)
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type)
|
LayoutReference[] |
getLayouts(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
|
int |
getLayoutsCount()
Gets the number of layouts. |
long |
getNextLayoutId(long groupId,
boolean privateLayout)
|
List<Layout> |
getNullFriendlyURLLayouts()
|
boolean |
hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
|
void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
|
void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds)
|
Layout |
updateFriendlyURL(long plid,
String friendlyURL)
|
Layout |
updateLayout(Layout layout)
Updates the layout in the database. |
Layout |
updateLayout(Layout layout,
boolean merge)
Updates the layout in the database. |
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
String description,
String type,
boolean hidden,
String friendlyURL,
Boolean iconImage,
byte[] iconBytes,
ServiceContext serviceContext)
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
Map<Locale,String> localeNamesMap,
Map<Locale,String> localeTitlesMap,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
|
Layout |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
|
Layout |
updateName(Layout layout,
String name,
String languageId)
|
Layout |
updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
|
Layout |
updateName(long plid,
String name,
String languageId)
|
Layout |
updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
|
Layout |
updateParentLayoutId(long plid,
long parentPlid)
|
Layout |
updatePriority(Layout layout,
int priority)
|
Layout |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
|
Layout |
updatePriority(long plid,
int priority)
|
Method Detail |
---|
Layout addLayout(Layout layout) throws SystemException
layout
- the layout to add
SystemException
- if a system exception occurredLayout createLayout(long plid)
plid
- the primary key for the new layout
void deleteLayout(long plid) throws PortalException, SystemException
plid
- the primary key of the layout to delete
PortalException
- if a layout with the primary key could not be found
SystemException
- if a system exception occurredvoid deleteLayout(Layout layout) throws SystemException
layout
- the layout to delete
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
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 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 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 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 occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayout(long plid) throws PortalException, SystemException
plid
- the primary key of the layout to get
PortalException
- if a layout with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayoutByUuidAndGroupId(String uuid, long groupId) throws PortalException, SystemException
uuid
- the UUID of layout to getgroupId
- the group id of the layout to get
PortalException
- if a layout with the UUID and group id could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(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 layouts to returnend
- the upper bound of the range of layouts to return (not inclusive)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsCount() throws SystemException
SystemException
- if a system exception occurredLayout updateLayout(Layout layout) throws SystemException
layout
- the layout to update
SystemException
- if a system exception occurredLayout updateLayout(Layout layout, boolean merge) throws SystemException
layout
- the layout to updatemerge
- whether to merge the layout 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 occurredLayout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, long dlFolderId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, long dlFolderId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
Layout addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void deleteLayout(Layout layout, boolean updateLayoutSet) throws PortalException, SystemException
PortalException
SystemException
void deleteLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException, SystemException
PortalException
SystemException
void deleteLayouts(long groupId, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
byte[] exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
byte[] exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
File exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
byte[] exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
File exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId, boolean privateLayout) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) long getDefaultPlid(long groupId, boolean privateLayout, String portletId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout getDLFolderLayout(long dlFolderId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Layout getLayoutByIconImageId(long iconImageId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, int start, int end) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, long[] layoutIds) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutReference[] getLayouts(long companyId, String portletId, String preferencesKey, String preferencesValue) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) long getNextLayoutId(long groupId, boolean privateLayout) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Layout> getNullFriendlyURLLayouts() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes) throws PortalException, SystemException
PortalException
SystemException
void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds) throws PortalException, SystemException
PortalException
SystemException
Layout updateFriendlyURL(long plid, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException, SystemException
PortalException
SystemException
Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme) throws PortalException, SystemException
PortalException
SystemException
Layout updateName(Layout layout, String name, String languageId) throws PortalException, SystemException
PortalException
SystemException
Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException, SystemException
PortalException
SystemException
Layout updateName(long plid, String name, String languageId) throws PortalException, SystemException
PortalException
SystemException
Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException, SystemException
PortalException
SystemException
Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException, SystemException
PortalException
SystemException
Layout updatePriority(Layout layout, int priority) throws SystemException
SystemException
Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException, SystemException
PortalException
SystemException
Layout updatePriority(long plid, int priority) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |