com.liferay.portal.kernel.service

Interface WebsiteLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

WebsiteLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface WebsiteLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for Website. 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:

WebsiteLocalServiceUtil, WebsiteLocalServiceBaseImpl, WebsiteLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Website	addWebsite(long userId, String className, long classPK, String url, long typeId, boolean primary, ServiceContext serviceContext)
Website	addWebsite(Website website) Adds the website to the database.
Website	createWebsite(long websiteId) Creates a new website with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
Website	deleteWebsite(long websiteId) Deletes the website with the primary key from the database.
Website	deleteWebsite(Website website) Deletes the website from the database.
void	deleteWebsites(long companyId, String className, long classPK)
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.
Website	fetchWebsite(long websiteId)
Website	fetchWebsiteByUuidAndCompanyId(String uuid, long companyId) Returns the website with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Website	getWebsite(long websiteId) Returns the website with the primary key.
Website	getWebsiteByUuidAndCompanyId(String uuid, long companyId) Returns the website with the matching UUID and company.
List<Website>	getWebsites()
List<Website>	getWebsites(int start, int end) Returns a range of all the websites.
List<Website>	getWebsites(long companyId, String className, long classPK)
int	getWebsitesCount() Returns the number of websites.
Website	updateWebsite(long websiteId, String url, long typeId, boolean primary)
Website	updateWebsite(Website website) Updates the website in the database or adds it if it does not yet exist.

Method Detail

addWebsite

Website addWebsite(long userId,
                   String className,
                   long classPK,
                   String url,
                   long typeId,
                   boolean primary,
                   ServiceContext serviceContext)
            throws PortalException

Throws:

PortalException

addWebsite

@Indexable(type=REINDEX)
Website addWebsite(Website website)

Adds the website to the database. Also notifies the appropriate model listeners.

Parameters:

website - the website

Returns:

the website that was added

createWebsite

@Transactional(enabled=false)
Website createWebsite(long websiteId)

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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteWebsite

@Indexable(type=DELETE)
Website deleteWebsite(long websiteId)
                                       throws PortalException

Deletes the website with the primary key from the database. Also notifies the appropriate model listeners.

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

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
Website deleteWebsite(Website website)

Deletes the website from the database. Also notifies the appropriate model listeners.

Parameters:

website - the website

Returns:

the website that was removed

deleteWebsites

void deleteWebsites(long companyId,
                    String className,
                    long classPK)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery 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 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 WebsiteModelImpl. 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - 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 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 WebsiteModelImpl. 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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 query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchWebsite

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Website fetchWebsite(long websiteId)

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 UUID

companyId - 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 interface PersistedModelLocalService

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

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 UUID

companyId - the primary key of the company

Returns:

the matching website

Throws:

PortalException - if a matching website could not be found

getWebsites

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Website> getWebsites()

getWebsites

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Website> getWebsites(int start,
                                                                                             int end)

Returns a range of all the websites.

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 WebsiteModelImpl. 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.

Parameters:

start - the lower bound of the range of websites

end - 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWebsitesCount()

Returns the number of websites.

Returns:

the number of websites

updateWebsite

Website updateWebsite(long websiteId,
                      String url,
                      long typeId,
                      boolean primary)
               throws PortalException

Throws:

PortalException

updateWebsite

@Indexable(type=REINDEX)
Website updateWebsite(Website website)

Updates the website in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

website - the website

Returns:

the website that was updated