public class LayoutSetLocalServiceUtil
extends Object
com.liferay.portal.service.impl.LayoutSetLocalServiceImpl
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.LayoutSetLocalService
Constructor and Description |
---|
LayoutSetLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static LayoutSet |
addLayoutSet(LayoutSet layoutSet)
Adds the layout set to the database.
|
static LayoutSet |
addLayoutSet(long groupId,
boolean privateLayout) |
static LayoutSet |
createLayoutSet(long layoutSetId)
Creates a new layout set with the primary key.
|
static PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
static LayoutSet |
deleteLayoutSet(LayoutSet layoutSet)
Deletes the layout set from the database.
|
static LayoutSet |
deleteLayoutSet(long layoutSetId)
Deletes the layout set with the primary key from the database.
|
static void |
deleteLayoutSet(long groupId,
boolean privateLayout,
ServiceContext serviceContext) |
static PersistedModel |
deletePersistedModel(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 DynamicQuery |
dynamicQuery() |
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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 matching the dynamic query.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
static LayoutSet |
fetchLayoutSet(long layoutSetId) |
static LayoutSet |
fetchLayoutSet(long groupId,
boolean privateLayout) |
static LayoutSet |
fetchLayoutSet(String virtualHostname) |
static LayoutSet |
fetchLayoutSetByLogoId(boolean privateLayout,
long logoId) |
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static LayoutSet |
getLayoutSet(long layoutSetId)
Returns the layout set with the primary key.
|
static LayoutSet |
getLayoutSet(long groupId,
boolean privateLayout) |
static LayoutSet |
getLayoutSet(String virtualHostname) |
static List<LayoutSet> |
getLayoutSets(int start,
int end)
Returns a range of all the layout sets.
|
static List<LayoutSet> |
getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) |
static int |
getLayoutSetsCount()
Returns the number of layout sets.
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static int |
getPageCount(long groupId,
boolean privateLayout) |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static LayoutSetLocalService |
getService() |
static void |
setService(LayoutSetLocalService service) |
static LayoutSet |
updateFaviconFileEntryId(long groupId,
boolean privateLayout,
long faviconFileEntryId) |
static LayoutSet |
updateLayoutSet(LayoutSet layoutSet)
Updates the layout set in the database or adds it if it does not yet exist.
|
static void |
updateLayoutSetPrototypeLinkEnabled(long groupId,
boolean privateLayout,
boolean layoutSetPrototypeLinkEnabled,
String layoutSetPrototypeUuid)
Updates the state of the layout set prototype link.
|
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
byte[] bytes) |
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
File file) |
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
InputStream inputStream) |
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
InputStream inputStream,
boolean cleanUpStream) |
static LayoutSet |
updateLookAndFeel(long groupId,
boolean privateLayout,
String themeId,
String colorSchemeId,
String css) |
static void |
updateLookAndFeel(long groupId,
String themeId,
String colorSchemeId,
String css) |
static LayoutSet |
updateSettings(long groupId,
boolean privateLayout,
String settings) |
static LayoutSet |
updateVirtualHosts(long groupId,
boolean privateLayout,
TreeMap<String,String> virtualHostnames) |
public static LayoutSet addLayoutSet(LayoutSet layoutSet)
Important: Inspect LayoutSetLocalServiceImpl 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.
layoutSet
- the layout setpublic static LayoutSet addLayoutSet(long groupId, boolean privateLayout) throws PortalException
PortalException
public static LayoutSet createLayoutSet(long layoutSetId)
layoutSetId
- the primary key for the new layout setpublic static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static LayoutSet deleteLayoutSet(LayoutSet layoutSet)
Important: Inspect LayoutSetLocalServiceImpl 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.
layoutSet
- the layout setpublic static LayoutSet deleteLayoutSet(long layoutSetId) throws PortalException
Important: Inspect LayoutSetLocalServiceImpl 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.
layoutSetId
- the primary key of the layout setPortalException
- if a layout set with the primary key could not be foundpublic static void deleteLayoutSet(long groupId, boolean privateLayout, ServiceContext serviceContext) throws PortalException
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
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 DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(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.portal.model.impl.LayoutSetModelImpl
.
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> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, 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.portal.model.impl.LayoutSetModelImpl
.
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(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static LayoutSet fetchLayoutSet(long layoutSetId)
public static LayoutSet fetchLayoutSet(long groupId, boolean privateLayout)
public static LayoutSet fetchLayoutSet(String virtualHostname)
public static LayoutSet fetchLayoutSetByLogoId(boolean privateLayout, long logoId) throws PortalException
PortalException
public static ActionableDynamicQuery getActionableDynamicQuery()
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static LayoutSet getLayoutSet(long layoutSetId) throws PortalException
layoutSetId
- the primary key of the layout setPortalException
- if a layout set with the primary key could not be foundpublic static LayoutSet getLayoutSet(long groupId, boolean privateLayout) throws PortalException
PortalException
public static LayoutSet getLayoutSet(String virtualHostname) throws PortalException
PortalException
public static List<LayoutSet> getLayoutSets(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.portal.model.impl.LayoutSetModelImpl
.
start
- the lower bound of the range of layout setsend
- the upper bound of the range of layout sets (not inclusive)public static List<LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
public static int getLayoutSetsCount()
public static String getOSGiServiceIdentifier()
public static int getPageCount(long groupId, boolean privateLayout)
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static LayoutSet updateFaviconFileEntryId(long groupId, boolean privateLayout, long faviconFileEntryId) throws PortalException
PortalException
public static LayoutSet updateLayoutSet(LayoutSet layoutSet)
Important: Inspect LayoutSetLocalServiceImpl 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.
layoutSet
- the layout setpublic static void updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout set is private to the grouplayoutSetPrototypeLinkEnabled
- whether the layout set prototype is
link enabledlayoutSetPrototypeUuid
- the uuid of the layout set prototype to
link withPortalException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes) throws PortalException
PortalException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, File file) throws PortalException
PortalException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream) throws PortalException
PortalException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream) throws PortalException
PortalException
public static LayoutSet updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css) throws PortalException
PortalException
public static void updateLookAndFeel(long groupId, String themeId, String colorSchemeId, String css) throws PortalException
PortalException
public static LayoutSet updateSettings(long groupId, boolean privateLayout, String settings) throws PortalException
PortalException
public static LayoutSet updateVirtualHosts(long groupId, boolean privateLayout, TreeMap<String,String> virtualHostnames) throws PortalException
PortalException
public static LayoutSetLocalService getService()
public static void setService(LayoutSetLocalService service)