|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.LayoutSetLocalServiceUtil
@ProviderType public class LayoutSetLocalServiceUtil
Provides the local service utility for LayoutSet. This utility wraps
com.liferay.portal.service.impl.LayoutSetLocalServiceImpl
and is the
primary 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
,
LayoutSetLocalServiceBaseImpl
,
com.liferay.portal.service.impl.LayoutSetLocalServiceImpl
Constructor Summary | |
---|---|
LayoutSetLocalServiceUtil()
|
Method Summary | |
---|---|
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 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 DynamicQuery |
dynamicQuery()
|
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)
Returns the number of rows that match the dynamic query. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
static LayoutSet |
fetchLayoutSet(long layoutSetId)
|
static LayoutSet |
fetchLayoutSet(String virtualHostname)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
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 PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static LayoutSetLocalService |
getService()
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(LayoutSetLocalService service)
Deprecated. As of 6.2.0 |
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)
Deprecated. As of 6.1.0, replaced by updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
String) |
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 logo,
byte[] bytes)
|
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean logo,
File file)
|
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean logo,
InputStream is)
|
static LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean logo,
InputStream is,
boolean cleanUpStream)
|
static LayoutSet |
updateLookAndFeel(long groupId,
boolean privateLayout,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
|
static void |
updateLookAndFeel(long groupId,
String themeId,
String colorSchemeId,
String css,
boolean wapTheme)
|
static LayoutSet |
updatePageCount(long groupId,
boolean privateLayout)
|
static LayoutSet |
updateSettings(long groupId,
boolean privateLayout,
String settings)
|
static LayoutSet |
updateVirtualHost(long groupId,
boolean privateLayout,
String virtualHostname)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LayoutSetLocalServiceUtil()
Method Detail |
---|
public static LayoutSet addLayoutSet(LayoutSet layoutSet) throws SystemException
layoutSet
- the layout set
SystemException
- if a system exception occurredpublic static LayoutSet createLayoutSet(long layoutSetId)
layoutSetId
- the primary key for the new layout set
public static LayoutSet deleteLayoutSet(long layoutSetId) throws PortalException, SystemException
layoutSetId
- the primary key of the layout set
PortalException
- if a layout set with the primary key could not be found
SystemException
- if a system exception occurredpublic static LayoutSet deleteLayoutSet(LayoutSet layoutSet) throws SystemException
layoutSet
- the layout set
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
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. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from LayoutSetModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 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. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from LayoutSetModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurredpublic static LayoutSet fetchLayoutSet(long layoutSetId) throws SystemException
SystemException
public static LayoutSet getLayoutSet(long layoutSetId) throws PortalException, SystemException
layoutSetId
- the primary key of the layout set
PortalException
- if a layout set with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public static List<LayoutSet> getLayoutSets(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. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from LayoutSetModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start
- the lower bound of the range of layout setsend
- the upper bound of the range of layout sets (not inclusive)
SystemException
- if a system exception occurredpublic static int getLayoutSetsCount() throws SystemException
SystemException
- if a system exception occurredpublic static LayoutSet updateLayoutSet(LayoutSet layoutSet) throws SystemException
layoutSet
- the layout set
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static LayoutSet addLayoutSet(long groupId, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
public static void deleteLayoutSet(long groupId, boolean privateLayout, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet fetchLayoutSet(String virtualHostname) throws SystemException
SystemException
public static LayoutSet getLayoutSet(long groupId, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet getLayoutSet(String virtualHostname) throws PortalException, SystemException
PortalException
SystemException
public static List<LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) throws SystemException
SystemException
public static void updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled) throws PortalException, SystemException
updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
String)
This method can disable the layout set prototype's link by setting
layoutSetPrototypeLinkEnabled
to false
.
However, this method can only enable the layout set prototype's link if
the layout set prototype's current uuid is not null
. Setting
the layoutSetPrototypeLinkEnabled
to true
when
the layout set prototype's current uuid is null
will have no
effect.
groupId
- the primary key of the groupprivateLayout
- whether the layout set is private to the grouplayoutSetPrototypeLinkEnabled
- whether the layout set
prototype is link enabled
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) throws PortalException, SystemException
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 with
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean logo, byte[] bytes) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean logo, File file) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is, boolean cleanUpStream) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css, boolean wapTheme) throws PortalException, SystemException
PortalException
SystemException
public static void updateLookAndFeel(long groupId, String themeId, String colorSchemeId, String css, boolean wapTheme) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updatePageCount(long groupId, boolean privateLayout) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updateSettings(long groupId, boolean privateLayout, String settings) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSet updateVirtualHost(long groupId, boolean privateLayout, String virtualHostname) throws PortalException, SystemException
PortalException
SystemException
public static LayoutSetLocalService getService()
public void setService(LayoutSetLocalService service)
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |