Interface WebsiteLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
WebsiteLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddWebsite
(Website website) Adds the website to the database.addWebsite
(String externalReferenceCode, long userId, String className, long classPK, String url, long listTypeId, boolean primary, ServiceContext serviceContext) createPersistedModel
(Serializable primaryKeyObj) createWebsite
(long websiteId) Creates a new website with the primary key.deletePersistedModel
(PersistedModel persistedModel) deleteWebsite
(long websiteId) Deletes the website with the primary key from the database.deleteWebsite
(Website website) Deletes the website from the database.void
deleteWebsites
(long companyId, String className, long classPK) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchWebsite
(long websiteId) fetchWebsiteByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchWebsiteByUuidAndCompanyId
(String uuid, long companyId) Returns the website with the matching UUID and company.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getWebsite
(long websiteId) Returns the website with the primary key.getWebsiteByExternalReferenceCode
(String externalReferenceCode, long companyId) getWebsiteByUuidAndCompanyId
(String uuid, long companyId) Returns the website with the matching UUID and company.getWebsites
(int start, int end) Returns a range of all the websites.getWebsites
(long companyId, String className, long classPK) int
Returns the number of websites.updateWebsite
(Website website) Updates the website in the database or adds it if it does not yet exist.updateWebsite
(String externalReferenceCode, long websiteId, String url, long listTypeId, boolean primary) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addWebsite
Website addWebsite(String externalReferenceCode, long userId, String className, long classPK, String url, long listTypeId, boolean primary, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addWebsite
Adds the website to the database. Also notifies the appropriate model listeners.Important: Inspect WebsiteLocalServiceImpl 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.
- Parameters:
website
- the website- Returns:
- the website that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createWebsite
Creates a new website with the primary key. Does not add the website to the database.- Parameters:
websiteId
- the primary key for the new website- Returns:
- the new website
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteWebsite
Deletes the website with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect WebsiteLocalServiceImpl 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.
- Parameters:
websiteId
- the primary key of the website- Returns:
- the website that was removed
- Throws:
PortalException
- if a website with the primary key could not be found
-
deleteWebsite
Deletes the website from the database. Also notifies the appropriate model listeners.Important: Inspect WebsiteLocalServiceImpl 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.
- Parameters:
website
- the website- Returns:
- the website that was removed
-
deleteWebsites
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.WebsiteModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.WebsiteModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchWebsite
-
fetchWebsiteByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Website fetchWebsiteByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchWebsiteByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Website fetchWebsiteByUuidAndCompanyId(String uuid, long companyId) Returns the website with the matching UUID and company.- Parameters:
uuid
- the website's UUIDcompanyId
- the primary key of the company- Returns:
- the matching website, or
null
if a matching website could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getWebsite
@Transactional(propagation=SUPPORTS, readOnly=true) Website getWebsite(long websiteId) throws PortalException Returns the website with the primary key.- Parameters:
websiteId
- the primary key of the website- Returns:
- the website
- Throws:
PortalException
- if a website with the primary key could not be found
-
getWebsiteByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Website getWebsiteByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getWebsiteByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Website getWebsiteByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the website with the matching UUID and company.- Parameters:
uuid
- the website's UUIDcompanyId
- the primary key of the company- Returns:
- the matching website
- Throws:
PortalException
- if a matching website could not be found
-
getWebsites
-
getWebsites
Returns a range of all the websites.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.WebsiteModelImpl
.- Parameters:
start
- the lower bound of the range of websitesend
- the upper bound of the range of websites (not inclusive)- Returns:
- the range of websites
-
getWebsites
@Transactional(propagation=SUPPORTS, readOnly=true) List<Website> getWebsites(long companyId, String className, long classPK) -
getWebsitesCount
Returns the number of websites.- Returns:
- the number of websites
-
updateWebsite
Website updateWebsite(String externalReferenceCode, long websiteId, String url, long listTypeId, boolean primary) throws PortalException - Throws:
PortalException
-
updateWebsite
Updates the website in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect WebsiteLocalServiceImpl 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.
- Parameters:
website
- the website- Returns:
- the website that was updated
-