@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface LayoutSetLocalService extends BaseLocalService, PersistedModelLocalService, VersionService<LayoutSet,LayoutSetVersion>
LayoutSetLocalServiceUtil| Modifier and Type | Method and Description |
|---|---|
LayoutSet |
addLayoutSet(LayoutSet layoutSet)
Adds the layout set to the database.
|
LayoutSet |
addLayoutSet(long groupId,
boolean privateLayout) |
LayoutSet |
checkout(LayoutSet publishedLayoutSet,
int version)
Checks out the previous version of the versioned model and saves it as a
draft.
|
LayoutSet |
create()
Creates a new layout set.
|
LayoutSet |
delete(LayoutSet publishedLayoutSet)
Deletes the
VersionedModel. |
LayoutSet |
deleteDraft(LayoutSet draftLayoutSet)
Deletes the
VersionedModel if it is a draft. |
LayoutSet |
deleteLayoutSet(LayoutSet layoutSet)
Deletes the layout set from the database.
|
LayoutSet |
deleteLayoutSet(long layoutSetId)
Deletes the layout set with the primary key from the database.
|
void |
deleteLayoutSet(long groupId,
boolean privateLayout,
ServiceContext serviceContext) |
PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
LayoutSetVersion |
deleteVersion(LayoutSetVersion layoutSetVersion)
Deletes the
VersionModel if it is not the latest version. |
DynamicQuery |
dynamicQuery() |
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<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.
|
<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.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
LayoutSet |
fetchDraft(LayoutSet layoutSet)
Fetches the draft if it exists; otherwise, returns
null. |
LayoutSet |
fetchDraft(long primaryKey)
Fetches the draft if it exists; otherwise, returns
null. |
LayoutSetVersion |
fetchLatestVersion(LayoutSet layoutSet)
Fetches the latest version model if it exists.
|
LayoutSet |
fetchLayoutSet(long layoutSetId) |
LayoutSet |
fetchLayoutSet(long groupId,
boolean privateLayout) |
LayoutSet |
fetchLayoutSet(String virtualHostname) |
LayoutSet |
fetchLayoutSetByLogoId(boolean privateLayout,
long logoId) |
LayoutSet |
fetchPublished(LayoutSet layoutSet)
Fetches the published versioned model if it exists.
|
LayoutSet |
fetchPublished(long primaryKey)
Fetches the published versioned model if it exists; otherwise, returns
null. |
ActionableDynamicQuery |
getActionableDynamicQuery() |
LayoutSet |
getDraft(LayoutSet layoutSet)
Returns the versioned model draft.
|
LayoutSet |
getDraft(long primaryKey)
Returns the versioned model draft with the primary key.
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
LayoutSet |
getLayoutSet(long layoutSetId)
Returns the layout set with the primary key.
|
LayoutSet |
getLayoutSet(long groupId,
boolean privateLayout) |
LayoutSet |
getLayoutSet(String virtualHostname) |
List<LayoutSet> |
getLayoutSets(int start,
int end)
Returns a range of all the layout sets.
|
List<LayoutSet> |
getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) |
int |
getLayoutSetsCount()
Returns the number of layout sets.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
LayoutSetVersion |
getVersion(LayoutSet layoutSet,
int version)
Returns the
VersionModel for the VersionedModel matching
the version. |
List<LayoutSetVersion> |
getVersions(LayoutSet layoutSet)
Returns the
VersionModels for the VersionedModel. |
LayoutSet |
publishDraft(LayoutSet draftLayoutSet)
Publishes the draft and creates a new version model for the new version.
|
void |
registerListener(VersionServiceListener<LayoutSet,LayoutSetVersion> versionServiceListener)
Registers the
VersionServiceListener. |
void |
unregisterListener(VersionServiceListener<LayoutSet,LayoutSetVersion> versionServiceListener)
Unregisters the
VersionServiceListener. |
LayoutSet |
updateDraft(LayoutSet draftLayoutSet)
Updates the draft.
|
LayoutSet |
updateLayoutSet(LayoutSet draftLayoutSet)
Updates the layout set in the database or adds it if it does not yet exist.
|
void |
updateLayoutSetPrototypeLinkEnabled(long groupId,
boolean privateLayout,
boolean layoutSetPrototypeLinkEnabled,
String layoutSetPrototypeUuid)
Updates the state of the layout set prototype link.
|
LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
byte[] bytes) |
LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
File file) |
LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
InputStream is) |
LayoutSet |
updateLogo(long groupId,
boolean privateLayout,
boolean hasLogo,
InputStream is,
boolean cleanUpStream) |
LayoutSet |
updateLookAndFeel(long groupId,
boolean privateLayout,
String themeId,
String colorSchemeId,
String css) |
void |
updateLookAndFeel(long groupId,
String themeId,
String colorSchemeId,
String css) |
LayoutSet |
updatePageCount(long groupId,
boolean privateLayout) |
LayoutSet |
updateSettings(long groupId,
boolean privateLayout,
String settings) |
LayoutSet |
updateVirtualHost(long groupId,
boolean privateLayout,
String virtualHostname) |
@Indexable(type=REINDEX) LayoutSet addLayoutSet(LayoutSet layoutSet)
layoutSet - the layout setLayoutSet addLayoutSet(long groupId, boolean privateLayout) throws PortalException
PortalException@Indexable(type=REINDEX) LayoutSet checkout(LayoutSet publishedLayoutSet, int version) throws PortalException
VersionServiceVersionServiceListener that has been registered is
also notified. An IllegalArgumentException is thrown if the
versioned model already has a draft.checkout in interface VersionService<LayoutSet,LayoutSetVersion>publishedLayoutSet - the published versioned modelversion - the versionVersionModel being checked outPortalException - if the version does not exist@Transactional(enabled=false) LayoutSet create()
create in interface VersionService<LayoutSet,LayoutSetVersion>@Indexable(type=DELETE) LayoutSet delete(LayoutSet publishedLayoutSet) throws PortalException
VersionServiceVersionedModel. Related drafts and versions are also
deleted. Any VersionServiceListener that has been registered is
notified. An IllegalArgumentException is thrown if the versioned
model is a draft. Drafts can be deleted by calling VersionService.deleteDraft(VersionedModel).delete in interface VersionService<LayoutSet,LayoutSetVersion>publishedLayoutSet - the published versioned modelPortalException - if a portal exception occurred@Indexable(type=DELETE) LayoutSet deleteDraft(LayoutSet draftLayoutSet) throws PortalException
VersionServiceVersionedModel if it is a draft. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a
draft. Published versioned models can be deleted by calling VersionService.delete(VersionedModel).deleteDraft in interface VersionService<LayoutSet,LayoutSetVersion>draftLayoutSet - the draft versioned modelPortalException - if a portal exception occurred@Indexable(type=DELETE) LayoutSet deleteLayoutSet(LayoutSet layoutSet)
layoutSet - the layout set@Indexable(type=DELETE) LayoutSet deleteLayoutSet(long layoutSetId) throws PortalException
layoutSetId - the primary key of the layout setPortalException - if a layout set with the primary key could not be foundvoid deleteLayoutSet(long groupId,
boolean privateLayout,
ServiceContext serviceContext)
throws PortalException
PortalExceptionPersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel in interface PersistedModelLocalServicePortalExceptionLayoutSetVersion deleteVersion(LayoutSetVersion layoutSetVersion) throws PortalException
VersionServiceVersionModel if it is not the latest version. Any
VersionServiceListener that has been registered is notified. An
IllegalArgumentException is thrown if the versioned model is the
latest version.deleteVersion in interface VersionService<LayoutSet,LayoutSetVersion>layoutSetVersion - the version modelPortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <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)@Transactional(propagation=SUPPORTS, readOnly=true) <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)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchDraft(LayoutSet layoutSet)
VersionServicenull.fetchDraft in interface VersionService<LayoutSet,LayoutSetVersion>layoutSet - the draft or published versioned modelnull@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchDraft(long primaryKey)
VersionServicenull.fetchDraft in interface VersionService<LayoutSet,LayoutSetVersion>primaryKey - the draft or published versioned model's primary keynull@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetVersion fetchLatestVersion(LayoutSet layoutSet)
VersionServicenull is returned.fetchLatestVersion in interface VersionService<LayoutSet,LayoutSetVersion>layoutSet - the versioned modelnull@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSet(long layoutSetId)
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSet(long groupId, boolean privateLayout)
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSet(String virtualHostname)
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSetByLogoId(boolean privateLayout, long logoId) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchPublished(LayoutSet layoutSet)
VersionServicenull is returned.fetchPublished in interface VersionService<LayoutSet,LayoutSetVersion>layoutSet - the versioned modelnull@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchPublished(long primaryKey)
VersionServicenull.fetchPublished in interface VersionService<LayoutSet,LayoutSetVersion>primaryKey - the published versioned model's primary keynull@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getDraft(LayoutSet layoutSet) throws PortalException
VersionServiceVersionServiceListener that has been registered is notified.getDraft in interface VersionService<LayoutSet,LayoutSetVersion>layoutSet - the versioned modelPortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getDraft(long primaryKey) throws PortalException
VersionServiceVersionServiceListener that has been
registered is notified.getDraft in interface VersionService<LayoutSet,LayoutSetVersion>primaryKey - of the draft or published versioned modelPortalException - if no draft or published versioned model exists
with the primary key@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getLayoutSet(long groupId, boolean privateLayout) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getLayoutSet(String virtualHostname) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) 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)@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutSetsCount()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel in interface PersistedModelLocalServicePortalException@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetVersion getVersion(LayoutSet layoutSet, int version) throws PortalException
VersionServiceVersionModel for the VersionedModel matching
the version.getVersion in interface VersionService<LayoutSet,LayoutSetVersion>layoutSet - the versioned modelversion - the versionPortalException - if the version does not exist@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSetVersion> getVersions(LayoutSet layoutSet)
VersionServiceVersionModels for the VersionedModel. They
are sorted in descending order.getVersions in interface VersionService<LayoutSet,LayoutSetVersion>layoutSet - the versioned model@Indexable(type=REINDEX) LayoutSet publishDraft(LayoutSet draftLayoutSet) throws PortalException
VersionServiceVersionServiceListener that has been registered is notified.
An IllegalArgumentException is thrown if the versioned model is
not a draft.publishDraft in interface VersionService<LayoutSet,LayoutSetVersion>draftLayoutSet - the draft version modelPortalException - if a portal exception occurredvoid registerListener(VersionServiceListener<LayoutSet,LayoutSetVersion> versionServiceListener)
VersionServiceVersionServiceListener.registerListener in interface VersionService<LayoutSet,LayoutSetVersion>versionServiceListener - the version service listener to registervoid unregisterListener(VersionServiceListener<LayoutSet,LayoutSetVersion> versionServiceListener)
VersionServiceVersionServiceListener.unregisterListener in interface VersionService<LayoutSet,LayoutSetVersion>versionServiceListener - the version service listener to unregister@Indexable(type=REINDEX) LayoutSet updateDraft(LayoutSet draftLayoutSet) throws PortalException
VersionServiceVersionServiceListener that has been
registered is notified. An IllegalArgumentException is thrown if
the versioned model is not a draft.updateDraft in interface VersionService<LayoutSet,LayoutSetVersion>draftLayoutSet - the draft version modelPortalException - if a portal exception occurred@Indexable(type=REINDEX) LayoutSet updateLayoutSet(LayoutSet draftLayoutSet) throws PortalException
layoutSet - the layout setPortalExceptionvoid 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 withPortalExceptionLayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes) throws PortalException
PortalExceptionLayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, File file) throws PortalException
PortalExceptionLayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream is) throws PortalException
PortalExceptionLayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream is, boolean cleanUpStream) throws PortalException
PortalExceptionLayoutSet updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css) throws PortalException
PortalExceptionvoid updateLookAndFeel(long groupId,
String themeId,
String colorSchemeId,
String css)
throws PortalException
PortalExceptionLayoutSet updatePageCount(long groupId, boolean privateLayout) throws PortalException
PortalExceptionLayoutSet updateSettings(long groupId, boolean privateLayout, String settings) throws PortalException
PortalExceptionLayoutSet updateVirtualHost(long groupId, boolean privateLayout, String virtualHostname) throws PortalException
PortalException