Liferay 6.2-ce-ga5

com.liferay.portal.service
Class WebsiteLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.WebsiteLocalServiceUtil

@ProviderType
public class WebsiteLocalServiceUtil
extends Object

Provides the local service utility for Website. This utility wraps WebsiteLocalServiceImpl and is the primary 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.

See Also:
WebsiteLocalService, WebsiteLocalServiceBaseImpl, WebsiteLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
WebsiteLocalServiceUtil()
           
 
Method Summary
static Website addWebsite(long userId, String className, long classPK, String url, int typeId, boolean primary)
          Deprecated. As of 6.2.0, replaced by addWebsite(long, String, long, String, int, boolean, ServiceContext)
static Website addWebsite(long userId, String className, long classPK, String url, int typeId, boolean primary, ServiceContext serviceContext)
           
static Website addWebsite(Website website)
          Adds the website to the database.
static Website createWebsite(long websiteId)
          Creates a new website with the primary key.
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 DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static Website fetchWebsite(long websiteId)
           
static Website fetchWebsiteByUuidAndCompanyId(String uuid, long companyId)
          Returns the website with the matching UUID and company.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static WebsiteLocalService getService()
           
static Website getWebsite(long websiteId)
          Returns the website with the primary key.
static Website getWebsiteByUuidAndCompanyId(String uuid, long companyId)
          Returns the website with the matching UUID and company.
static List<Website> getWebsites()
           
static List<Website> getWebsites(int start, int end)
          Returns a range of all the websites.
static List<Website> getWebsites(long companyId, String className, long classPK)
           
static int getWebsitesCount()
          Returns the number of websites.
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(WebsiteLocalService service)
          Deprecated. As of 6.2.0
static Website updateWebsite(long websiteId, String url, int typeId, boolean primary)
           
static Website updateWebsite(Website website)
          Updates the website in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebsiteLocalServiceUtil

public WebsiteLocalServiceUtil()
Method Detail

addWebsite

public static 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

public static 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

public static 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

public static 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

public static DynamicQuery dynamicQuery()

dynamicQuery

public static 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

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

dynamicQuery

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

dynamicQueryCount

public static 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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

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

fetchWebsite

public static Website fetchWebsite(long websiteId)
                            throws SystemException
Throws:
SystemException

fetchWebsiteByUuidAndCompanyId

public static Website fetchWebsiteByUuidAndCompanyId(String uuid,
                                                     long companyId)
                                              throws SystemException
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
Throws:
SystemException - if a system exception occurred

getWebsite

public static 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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getWebsiteByUuidAndCompanyId

public static Website getWebsiteByUuidAndCompanyId(String uuid,
                                                   long companyId)
                                            throws PortalException,
                                                   SystemException
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
SystemException - if a system exception occurred

getWebsites

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

getWebsitesCount

public static int getWebsitesCount()
                            throws SystemException
Returns the number of websites.

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

updateWebsite

public static 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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addWebsite

public static Website addWebsite(long userId,
                                 String className,
                                 long classPK,
                                 String url,
                                 int typeId,
                                 boolean primary)
                          throws PortalException,
                                 SystemException
Deprecated. As of 6.2.0, replaced by addWebsite(long, String, long, String, int, boolean, ServiceContext)

Throws:
PortalException
SystemException

addWebsite

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

deleteWebsites

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

getWebsites

public static List<Website> getWebsites()
                                 throws SystemException
Throws:
SystemException

getWebsites

public static List<Website> getWebsites(long companyId,
                                        String className,
                                        long classPK)
                                 throws SystemException
Throws:
SystemException

updateWebsite

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

getService

public static WebsiteLocalService getService()

setService

public void setService(WebsiteLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5