Liferay 6.0.5

com.liferay.portal.service
Interface WebsiteLocalService

All Known Implementing Classes:
WebsiteLocalServiceBaseImpl, WebsiteLocalServiceImpl, WebsiteLocalServiceWrapper

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

The interface for the website local service.

Never modify or reference this interface directly. Always use WebsiteLocalServiceUtil to access the website local service. Add custom service methods to WebsiteLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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, WebsiteLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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.
 void deleteWebsite(long websiteId)
          Deletes the website with the primary key from the database.
 void deleteWebsite(Website website)
          Deletes the website from the database.
 void deleteWebsites(long companyId, String className, long classPK)
           
 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)
          Counts the number of rows that match the dynamic query.
 Website getWebsite(long websiteId)
          Gets the website with the primary key.
 List<Website> getWebsites()
           
 List<Website> getWebsites(int start, int end)
          Gets a range of all the websites.
 List<Website> getWebsites(long companyId, String className, long classPK)
           
 int getWebsitesCount()
          Gets the number of websites.
 Website updateWebsite(long websiteId, String url, int typeId, boolean primary)
           
 Website updateWebsite(Website website)
          Updates the website in the database.
 Website updateWebsite(Website website, boolean merge)
          Updates the website in the database.
 

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 to add
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

void 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 to delete
Throws:
PortalException - if a website with the primary key could not be found
SystemException - if a system exception occurred

deleteWebsite

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

Parameters:
website - the website to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getWebsite

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Website getWebsite(long websiteId)
                   throws PortalException,
                          SystemException
Gets the website with the primary key.

Parameters:
websiteId - the primary key of the website to get
Returns:
the website
Throws:
PortalException - if a website with the primary key could not be found
SystemException - if a system exception occurred

getWebsites

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Website> getWebsites(int start,
                                                                   int end)
                          throws SystemException
Gets 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 to return
end - the upper bound of the range of websites to return (not inclusive)
Returns:
the range of websites
Throws:
SystemException - if a system exception occurred

getWebsitesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWebsitesCount()
                     throws SystemException
Gets 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. Also notifies the appropriate model listeners.

Parameters:
website - the website to update
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. Also notifies the appropriate model listeners.

Parameters:
website - the website to update
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

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