public class LayoutUtilityPageEntryLocalServiceUtil
extends java.lang.Object
com.liferay.layout.utility.page.service.impl.LayoutUtilityPageEntryLocalServiceImpl
and
is an 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.LayoutUtilityPageEntryLocalService
Constructor and Description |
---|
LayoutUtilityPageEntryLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static LayoutUtilityPageEntry |
addLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
Adds the layout utility page entry to the database.
|
static LayoutUtilityPageEntry |
addLayoutUtilityPageEntry(java.lang.String externalReferenceCode,
long userId,
long groupId,
long plid,
long previewFileEntryId,
boolean defaultLayoutUtilityPageEntry,
java.lang.String name,
java.lang.String type,
long masterLayoutPlid,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static LayoutUtilityPageEntry |
copyLayoutUtilityPageEntry(long userId,
long groupId,
long sourceLayoutUtilityPageEntryId,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static LayoutUtilityPageEntry |
createLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
Creates a new layout utility page entry with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static LayoutUtilityPageEntry |
deleteLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
Deletes the layout utility page entry from the database.
|
static LayoutUtilityPageEntry |
deleteLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
Deletes the layout utility page entry with the primary key from the database.
|
static LayoutUtilityPageEntry |
deleteLayoutUtilityPageEntry(java.lang.String externalReferenceCode,
long groupId) |
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
static LayoutUtilityPageEntry |
fetchDefaultLayoutUtilityPageEntry(long groupId,
java.lang.String type) |
static LayoutUtilityPageEntry |
fetchLayoutUtilityPageEntry(long LayoutUtilityPageEntryId) |
static LayoutUtilityPageEntry |
fetchLayoutUtilityPageEntry(long groupId,
java.lang.String name,
java.lang.String type) |
static LayoutUtilityPageEntry |
fetchLayoutUtilityPageEntryByExternalReferenceCode(java.lang.String externalReferenceCode,
long groupId) |
static LayoutUtilityPageEntry |
fetchLayoutUtilityPageEntryByPlid(long plid) |
static LayoutUtilityPageEntry |
fetchLayoutUtilityPageEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the layout utility page entry matching the UUID and group.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static LayoutUtilityPageEntry |
getDefaultLayoutUtilityPageEntry(long groupId,
java.lang.String type) |
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntries(int start,
int end)
Returns a range of all the layout utility page entries.
|
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntries(long groupId) |
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntries(long groupId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator) |
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntries(long groupId,
java.lang.String[] types,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator) |
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntries(long groupId,
java.lang.String type,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator) |
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntries(long groupId,
java.lang.String keyword,
java.lang.String[] types,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator) |
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntriesByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns all the layout utility page entries matching the UUID and company.
|
static java.util.List<LayoutUtilityPageEntry> |
getLayoutUtilityPageEntriesByUuidAndCompanyId(java.lang.String uuid,
long companyId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
Returns a range of layout utility page entries matching the UUID and company.
|
static int |
getLayoutUtilityPageEntriesCount()
Returns the number of layout utility page entries.
|
static int |
getLayoutUtilityPageEntriesCount(long groupId) |
static int |
getLayoutUtilityPageEntriesCount(long groupId,
java.lang.String[] types) |
static int |
getLayoutUtilityPageEntriesCount(long groupId,
java.lang.String keyword,
java.lang.String[] types) |
static LayoutUtilityPageEntry |
getLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
Returns the layout utility page entry with the primary key.
|
static LayoutUtilityPageEntry |
getLayoutUtilityPageEntryByExternalReferenceCode(java.lang.String externalReferenceCode,
long groupId) |
static LayoutUtilityPageEntry |
getLayoutUtilityPageEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the layout utility page entry matching the UUID and group.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static LayoutUtilityPageEntryLocalService |
getService() |
static LayoutUtilityPageEntry |
setDefaultLayoutUtilityPageEntry(long layoutUtilityPageEntryId) |
static LayoutUtilityPageEntry |
updateLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
Updates the layout utility page entry in the database or adds it if it does not yet exist.
|
static LayoutUtilityPageEntry |
updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId,
long previewFileEntryId) |
static LayoutUtilityPageEntry |
updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId,
java.lang.String name) |
public LayoutUtilityPageEntryLocalServiceUtil()
public static LayoutUtilityPageEntry addLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
Important: Inspect LayoutUtilityPageEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
layoutUtilityPageEntry
- the layout utility page entrypublic static LayoutUtilityPageEntry addLayoutUtilityPageEntry(java.lang.String externalReferenceCode, long userId, long groupId, long plid, long previewFileEntryId, boolean defaultLayoutUtilityPageEntry, java.lang.String name, java.lang.String type, long masterLayoutPlid, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntry copyLayoutUtilityPageEntry(long userId, long groupId, long sourceLayoutUtilityPageEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws java.lang.Exception
java.lang.Exception
public static LayoutUtilityPageEntry createLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
LayoutUtilityPageEntryId
- the primary key for the new layout utility page entrypublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect LayoutUtilityPageEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
layoutUtilityPageEntry
- the layout utility page entrycom.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(long LayoutUtilityPageEntryId) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect LayoutUtilityPageEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
LayoutUtilityPageEntryId
- the primary key of the layout utility page entrycom.liferay.portal.kernel.exception.PortalException
- if a layout utility page entry with the primary key could not be foundpublic static LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(java.lang.String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.layout.utility.page.model.impl.LayoutUtilityPageEntryModelImpl
.
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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.layout.utility.page.model.impl.LayoutUtilityPageEntryModelImpl
.
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 long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static LayoutUtilityPageEntry fetchDefaultLayoutUtilityPageEntry(long groupId, java.lang.String type)
public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntry(long groupId, java.lang.String name, java.lang.String type)
public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByExternalReferenceCode(java.lang.String externalReferenceCode, long groupId)
public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByPlid(long plid)
public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByUuidAndGroupId(java.lang.String uuid, long groupId)
uuid
- the layout utility page entry's UUIDgroupId
- the primary key of the groupnull
if a matching layout utility page entry could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static LayoutUtilityPageEntry getDefaultLayoutUtilityPageEntry(long groupId, java.lang.String type) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.layout.utility.page.model.impl.LayoutUtilityPageEntryModelImpl
.
start
- the lower bound of the range of layout utility page entriesend
- the upper bound of the range of layout utility page entries (not inclusive)public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId)
public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, java.lang.String type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, java.lang.String keyword, java.lang.String[] types, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, java.lang.String[] types, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
public static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the UUID of the layout utility page entriescompanyId
- the primary key of the companypublic static java.util.List<LayoutUtilityPageEntry> getLayoutUtilityPageEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
uuid
- the UUID of the layout utility page entriescompanyId
- the primary key of the companystart
- the lower bound of the range of layout utility page entriesend
- the upper bound of the range of layout utility page entries (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static int getLayoutUtilityPageEntriesCount()
public static int getLayoutUtilityPageEntriesCount(long groupId)
public static int getLayoutUtilityPageEntriesCount(long groupId, java.lang.String keyword, java.lang.String[] types)
public static int getLayoutUtilityPageEntriesCount(long groupId, java.lang.String[] types)
public static LayoutUtilityPageEntry getLayoutUtilityPageEntry(long LayoutUtilityPageEntryId) throws com.liferay.portal.kernel.exception.PortalException
LayoutUtilityPageEntryId
- the primary key of the layout utility page entrycom.liferay.portal.kernel.exception.PortalException
- if a layout utility page entry with the primary key could not be foundpublic static LayoutUtilityPageEntry getLayoutUtilityPageEntryByExternalReferenceCode(java.lang.String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntry getLayoutUtilityPageEntryByUuidAndGroupId(java.lang.String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the layout utility page entry's UUIDgroupId
- the primary key of the groupcom.liferay.portal.kernel.exception.PortalException
- if a matching layout utility page entry could not be foundpublic static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntry setDefaultLayoutUtilityPageEntry(long layoutUtilityPageEntryId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntry updateLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
Important: Inspect LayoutUtilityPageEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
layoutUtilityPageEntry
- the layout utility page entrypublic static LayoutUtilityPageEntry updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId, long previewFileEntryId)
public static LayoutUtilityPageEntry updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static LayoutUtilityPageEntryLocalService getService()