Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class VirtualHostLocalServiceUtil

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

public class VirtualHostLocalServiceUtil
extends Object

The utility for the virtual host local service. This utility wraps com.liferay.portal.service.impl.VirtualHostLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
VirtualHostLocalService, VirtualHostLocalServiceBaseImpl, com.liferay.portal.service.impl.VirtualHostLocalServiceImpl

Constructor Summary
VirtualHostLocalServiceUtil()
           
 
Method Summary
static VirtualHost addVirtualHost(VirtualHost virtualHost)
          Adds the virtual host to the database.
static VirtualHost createVirtualHost(long virtualHostId)
          Creates a new virtual host with the primary key.
static VirtualHost deleteVirtualHost(long virtualHostId)
          Deletes the virtual host with the primary key from the database.
static VirtualHost deleteVirtualHost(VirtualHost virtualHost)
          Deletes the virtual host from the database.
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 VirtualHost fetchVirtualHost(long virtualHostId)
           
static VirtualHost fetchVirtualHost(long companyId, long layoutSetId)
           
static VirtualHost fetchVirtualHost(String hostname)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static VirtualHostLocalService getService()
           
static VirtualHost getVirtualHost(long virtualHostId)
          Returns the virtual host with the primary key.
static VirtualHost getVirtualHost(long companyId, long layoutSetId)
           
static VirtualHost getVirtualHost(String hostname)
           
static List<VirtualHost> getVirtualHosts(int start, int end)
          Returns a range of all the virtual hosts.
static int getVirtualHostsCount()
          Returns the number of virtual hosts.
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(VirtualHostLocalService service)
          Deprecated.  
static VirtualHost updateVirtualHost(long companyId, long layoutSetId, String hostname)
           
static VirtualHost updateVirtualHost(VirtualHost virtualHost)
          Updates the virtual host in the database or adds it if it does not yet exist.
static VirtualHost updateVirtualHost(VirtualHost virtualHost, boolean merge)
          Updates the virtual host 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

VirtualHostLocalServiceUtil

public VirtualHostLocalServiceUtil()
Method Detail

addVirtualHost

public static VirtualHost addVirtualHost(VirtualHost virtualHost)
                                  throws SystemException
Adds the virtual host to the database. Also notifies the appropriate model listeners.

Parameters:
virtualHost - the virtual host
Returns:
the virtual host that was added
Throws:
SystemException - if a system exception occurred

createVirtualHost

public static VirtualHost createVirtualHost(long virtualHostId)
Creates a new virtual host with the primary key. Does not add the virtual host to the database.

Parameters:
virtualHostId - the primary key for the new virtual host
Returns:
the new virtual host

deleteVirtualHost

public static VirtualHost deleteVirtualHost(long virtualHostId)
                                     throws PortalException,
                                            SystemException
Deletes the virtual host with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
virtualHostId - the primary key of the virtual host
Returns:
the virtual host that was removed
Throws:
PortalException - if a virtual host with the primary key could not be found
SystemException - if a system exception occurred

deleteVirtualHost

public static VirtualHost deleteVirtualHost(VirtualHost virtualHost)
                                     throws SystemException
Deletes the virtual host from the database. Also notifies the appropriate model listeners.

Parameters:
virtualHost - the virtual host
Returns:
the virtual host 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.

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.

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

fetchVirtualHost

public static VirtualHost fetchVirtualHost(long virtualHostId)
                                    throws SystemException
Throws:
SystemException

getVirtualHost

public static VirtualHost getVirtualHost(long virtualHostId)
                                  throws PortalException,
                                         SystemException
Returns the virtual host with the primary key.

Parameters:
virtualHostId - the primary key of the virtual host
Returns:
the virtual host
Throws:
PortalException - if a virtual host 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

getVirtualHosts

public static List<VirtualHost> getVirtualHosts(int start,
                                                int end)
                                         throws SystemException
Returns a range of all the virtual hosts.

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 virtual hosts
end - the upper bound of the range of virtual hosts (not inclusive)
Returns:
the range of virtual hosts
Throws:
SystemException - if a system exception occurred

getVirtualHostsCount

public static int getVirtualHostsCount()
                                throws SystemException
Returns the number of virtual hosts.

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

updateVirtualHost

public static VirtualHost updateVirtualHost(VirtualHost virtualHost)
                                     throws SystemException
Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
virtualHost - the virtual host
Returns:
the virtual host that was updated
Throws:
SystemException - if a system exception occurred

updateVirtualHost

public static VirtualHost updateVirtualHost(VirtualHost virtualHost,
                                            boolean merge)
                                     throws SystemException
Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
virtualHost - the virtual host
merge - whether to merge the virtual host 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 virtual host 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

fetchVirtualHost

public static VirtualHost fetchVirtualHost(long companyId,
                                           long layoutSetId)
                                    throws SystemException
Throws:
SystemException

fetchVirtualHost

public static VirtualHost fetchVirtualHost(String hostname)
                                    throws SystemException
Throws:
SystemException

getVirtualHost

public static VirtualHost getVirtualHost(long companyId,
                                         long layoutSetId)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

getVirtualHost

public static VirtualHost getVirtualHost(String hostname)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

updateVirtualHost

public static VirtualHost updateVirtualHost(long companyId,
                                            long layoutSetId,
                                            String hostname)
                                     throws SystemException
Throws:
SystemException

getService

public static VirtualHostLocalService getService()

setService

public void setService(VirtualHostLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3