Class WebsiteLocalServiceUtil
com.liferay.portal.service.impl.WebsiteLocalServiceImpl
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Website
addWebsite
(Website website) Adds the website to the database.static Website
addWebsite
(String externalReferenceCode, long userId, String className, long classPK, String url, long listTypeId, boolean primary, ServiceContext serviceContext) static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static Website
createWebsite
(long websiteId) Creates a new website with the primary key.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static Website
deleteWebsite
(long websiteId) Deletes the website with the primary key from the database.static Website
deleteWebsite
(Website website) Deletes the website from the database.static void
deleteWebsites
(long companyId, String className, long classPK) 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
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 Website
fetchWebsite
(long websiteId) static Website
fetchWebsiteByExternalReferenceCode
(String externalReferenceCode, long companyId) static Website
fetchWebsiteByUuidAndCompanyId
(String uuid, long companyId) Returns the website with the matching UUID and company.static ActionableDynamicQuery
static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static WebsiteLocalService
static Website
getWebsite
(long websiteId) Returns the website with the primary key.static Website
getWebsiteByExternalReferenceCode
(String externalReferenceCode, long companyId) static Website
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) static int
Returns the number of websites.static void
setService
(WebsiteLocalService service) static Website
updateWebsite
(Website website) Updates the website in the database or adds it if it does not yet exist.static Website
updateWebsite
(String externalReferenceCode, long websiteId, String url, long listTypeId, boolean primary)
-
Constructor Details
-
WebsiteLocalServiceUtil
public WebsiteLocalServiceUtil()
-
-
Method Details
-
addWebsite
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - 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
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
public 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.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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchWebsiteByUuidAndCompanyId
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
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getWebsite
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
public static Website getWebsiteByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getWebsiteByUuidAndCompanyId
public static 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
-
getWebsitesCount
public static int getWebsitesCount()Returns the number of websites.- Returns:
- the number of websites
-
updateWebsite
public static 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
-
getService
-
setService
-