|
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.LayoutLocalServiceUtil
public class LayoutLocalServiceUtil
The utility for the layout local service. This utility wraps LayoutLocalServiceImpl
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 LayoutLocalServiceImpl
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.
LayoutLocalService
,
LayoutLocalServiceBaseImpl
,
LayoutLocalServiceImpl
Constructor Summary | |
---|---|
LayoutLocalServiceUtil()
|
Method Summary | |
---|---|
static Layout |
addLayout(Layout layout)
Adds the layout to the database. |
static 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)
|
static 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)
|
static 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)
|
static Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
|
static Layout |
createLayout(long plid)
Creates a new layout with the primary key. |
static void |
deleteLayout(Layout layout)
Deletes the layout from the database. |
static void |
deleteLayout(Layout layout,
boolean updateLayoutSet)
|
static void |
deleteLayout(long plid)
Deletes the layout with the primary key from the database. |
static void |
deleteLayout(long groupId,
boolean privateLayout,
long layoutId)
|
static void |
deleteLayouts(long groupId,
boolean privateLayout)
|
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 byte[] |
exportLayouts(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
static byte[] |
exportLayouts(long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
static File |
exportLayoutsAsFile(long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
static byte[] |
exportPortletInfo(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
static File |
exportPortletInfoAsFile(long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
Date startDate,
Date endDate)
|
static long |
getDefaultPlid(long groupId)
|
static long |
getDefaultPlid(long groupId,
boolean privateLayout)
|
static long |
getDefaultPlid(long groupId,
boolean privateLayout,
String portletId)
|
static Layout |
getDLFolderLayout(long dlFolderId)
|
static Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
|
static Layout |
getLayout(long plid)
Gets the layout with the primary key. |
static Layout |
getLayout(long groupId,
boolean privateLayout,
long layoutId)
|
static Layout |
getLayoutByIconImageId(long iconImageId)
|
static Layout |
getLayoutByUuidAndGroupId(String uuid,
long groupId)
Gets the layout with the UUID and group id. |
static List<Layout> |
getLayouts(int start,
int end)
Gets a range of all the layouts. |
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout)
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
int start,
int end)
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type)
|
static LayoutReference[] |
getLayouts(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
|
static int |
getLayoutsCount()
Gets the number of layouts. |
static long |
getNextLayoutId(long groupId,
boolean privateLayout)
|
static List<Layout> |
getNullFriendlyURLLayouts()
|
static LayoutLocalService |
getService()
|
static boolean |
hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
byte[] bytes)
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
File file)
|
static void |
importLayouts(long userId,
long groupId,
boolean privateLayout,
Map<String,String[]> parameterMap,
InputStream is)
|
static void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
File file)
|
static void |
importPortletInfo(long userId,
long plid,
long groupId,
String portletId,
Map<String,String[]> parameterMap,
InputStream is)
|
static void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds)
|
void |
setService(LayoutLocalService service)
|
static Layout |
updateFriendlyURL(long plid,
String friendlyURL)
|
static Layout |
updateLayout(Layout layout)
Updates the layout in the database. |
static Layout |
updateLayout(Layout layout,
boolean merge)
Updates the layout in the database. |
static 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)
|
static 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)
|
static Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
|
static Layout |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
|
static Layout |
updateName(Layout layout,
String name,
String languageId)
|
static Layout |
updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
|
static Layout |
updateName(long plid,
String name,
String languageId)
|
static Layout |
updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
|
static Layout |
updateParentLayoutId(long plid,
long parentPlid)
|
static Layout |
updatePriority(Layout layout,
int priority)
|
static Layout |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
|
static Layout |
updatePriority(long plid,
int priority)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LayoutLocalServiceUtil()
Method Detail |
---|
public static Layout addLayout(Layout layout) throws SystemException
layout
- the layout to add
SystemException
- if a system exception occurredpublic static Layout createLayout(long plid)
plid
- the primary key for the new layout
public static 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 occurredpublic static void deleteLayout(Layout layout) throws SystemException
layout
- the layout 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 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 occurredpublic static 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 occurredpublic static 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 occurredpublic static int getLayoutsCount() throws SystemException
SystemException
- if a system exception occurredpublic static Layout updateLayout(Layout layout) throws SystemException
layout
- the layout to update
SystemException
- if a system exception occurredpublic static Layout 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 occurredpublic static 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) throws PortalException, SystemException
PortalException
SystemException
public static 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
public static 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
public static 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
public static void deleteLayout(Layout layout, boolean updateLayoutSet) throws PortalException, SystemException
PortalException
SystemException
public static void deleteLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException, SystemException
PortalException
SystemException
public static void deleteLayouts(long groupId, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
public static byte[] exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
public static byte[] exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
public static File exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
public static byte[] exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
public static File exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) throws PortalException, SystemException
PortalException
SystemException
public static long getDefaultPlid(long groupId) throws SystemException
SystemException
public static long getDefaultPlid(long groupId, boolean privateLayout) throws SystemException
SystemException
public static long getDefaultPlid(long groupId, boolean privateLayout, String portletId) throws PortalException, SystemException
PortalException
SystemException
public static Layout getDLFolderLayout(long dlFolderId) throws PortalException, SystemException
PortalException
SystemException
public static Layout getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
public static Layout getLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException, SystemException
PortalException
SystemException
public static Layout getLayoutByIconImageId(long iconImageId) throws PortalException, SystemException
PortalException
SystemException
public static List<Layout> getLayouts(long groupId, boolean privateLayout) throws SystemException
SystemException
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, int start, int end) throws SystemException
SystemException
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long[] layoutIds) throws PortalException, SystemException
PortalException
SystemException
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws SystemException
SystemException
public static LayoutReference[] getLayouts(long companyId, String portletId, String preferencesKey, String preferencesValue) throws SystemException
SystemException
public static long getNextLayoutId(long groupId, boolean privateLayout) throws SystemException
SystemException
public static List<Layout> getNullFriendlyURLLayouts() throws SystemException
SystemException
public static boolean hasLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws SystemException
SystemException
public static void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes) throws PortalException, SystemException
PortalException
SystemException
public static void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
public static void importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
public static void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) throws PortalException, SystemException
PortalException
SystemException
public static void importPortletInfo(long userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is) throws PortalException, SystemException
PortalException
SystemException
public static void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateFriendlyURL(long plid, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
public static 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
public static 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
public static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateName(Layout layout, String name, String languageId) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateName(long plid, String name, String languageId) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException, SystemException
PortalException
SystemException
public static Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException, SystemException
PortalException
SystemException
public static Layout updatePriority(Layout layout, int priority) throws SystemException
SystemException
public static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException, SystemException
PortalException
SystemException
public static Layout updatePriority(long plid, int priority) throws PortalException, SystemException
PortalException
SystemException
public static LayoutLocalService getService()
public void setService(LayoutLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |