Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface WebsiteLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
WebsiteLocalServiceWrapper

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

The interface for the website local service.

This is a local service. 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.

See Also:
WebsiteLocalServiceUtil, WebsiteLocalServiceBaseImpl, com.liferay.portal.service.impl.WebsiteLocalServiceImpl

Method Summary
 Website addWebsite(long userId, String className, long classPK, String url, int typeId, boolean primary)
           
 Website addWebsite(Website website)
          Adds the website to the database.
 Website createWebsite(long websiteId)
          Creates a new website with the primary key.
 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()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 Website fetchWebsite(long websiteId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 Website getWebsite(long websiteId)
          Returns the website with the primary key.
 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.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 Website updateWebsite(long websiteId, String url, int typeId, boolean primary)
           
 Website updateWebsite(Website website)
          Updates the website in the database or adds it if it does not yet exist.
 Website updateWebsite(Website website, boolean merge)
          Updates the website in the database or adds it if it does not yet exist.
 

Method Detail

addWebsite

Website addWebsite(Website website)
                   throws SystemException
Adds the website to the database. Also notifies the appropriate model listeners.

Parameters:
website - the website
Returns:
the website that was added
Throws:
SystemException - if a system exception occurred

createWebsite

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

deleteWebsite

Website deleteWebsite(long websiteId)
                      throws PortalException,
                             SystemException
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
SystemException - if a system exception occurred

deleteWebsite

Website deleteWebsite(Website website)
                      throws SystemException
Deletes the website from the database. Also notifies the appropriate model listeners.

Parameters:
website - the website
Returns:
the website that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchWebsite

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Website fetchWebsite(long websiteId)
                     throws SystemException
Throws:
SystemException

getWebsite

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Website getWebsite(long websiteId)
                   throws PortalException,
                          SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getWebsites

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Website> getWebsites(int start,
                                                                   int end)
                          throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

getWebsitesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWebsitesCount()
                     throws SystemException
Returns the number of websites.

Returns:
the number of websites
Throws:
SystemException - if a system exception occurred

updateWebsite

Website updateWebsite(Website website)
                      throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateWebsite

Website updateWebsite(Website website,
                      boolean merge)
                      throws SystemException
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
merge - whether to merge the website with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the website that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addWebsite

Website addWebsite(long userId,
                   String className,
                   long classPK,
                   String url,
                   int typeId,
                   boolean primary)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

deleteWebsites

void deleteWebsites(long companyId,
                    String className,
                    long classPK)
                    throws SystemException
Throws:
SystemException

getWebsites

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Website> getWebsites()
                          throws SystemException
Throws:
SystemException

getWebsites

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Website> getWebsites(long companyId,
                                                                   String className,
                                                                   long classPK)
                          throws SystemException
Throws:
SystemException

updateWebsite

Website updateWebsite(long websiteId,
                      String url,
                      int typeId,
                      boolean primary)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3