Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface VirtualHostLocalService

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

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

Provides the local service interface for VirtualHost. 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:
VirtualHostLocalServiceUtil, VirtualHostLocalServiceBaseImpl, com.liferay.portal.service.impl.VirtualHostLocalServiceImpl

Method Summary
 VirtualHost addVirtualHost(VirtualHost virtualHost)
          Adds the virtual host to the database.
 VirtualHost createVirtualHost(long virtualHostId)
          Creates a new virtual host with the primary key.
 VirtualHost deleteVirtualHost(long virtualHostId)
          Deletes the virtual host with the primary key from the database.
 VirtualHost deleteVirtualHost(VirtualHost virtualHost)
          Deletes the virtual host from the database.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 VirtualHost fetchVirtualHost(long virtualHostId)
           
 VirtualHost fetchVirtualHost(long companyId, long layoutSetId)
           
 VirtualHost fetchVirtualHost(String hostname)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 VirtualHost getVirtualHost(long virtualHostId)
          Returns the virtual host with the primary key.
 VirtualHost getVirtualHost(long companyId, long layoutSetId)
           
 VirtualHost getVirtualHost(String hostname)
           
 List<VirtualHost> getVirtualHosts(int start, int end)
          Returns a range of all the virtual hosts.
 int getVirtualHostsCount()
          Returns the number of virtual hosts.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 VirtualHost updateVirtualHost(long companyId, long layoutSetId, String hostname)
           
 VirtualHost updateVirtualHost(VirtualHost virtualHost)
          Updates the virtual host in the database or adds it if it does not yet exist.
 

Method Detail

addVirtualHost

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

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

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

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

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

fetchVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost fetchVirtualHost(long virtualHostId)
                             throws SystemException
Throws:
SystemException

getVirtualHost

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

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

getVirtualHosts

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getVirtualHostsCount()
                         throws SystemException
Returns the number of virtual hosts.

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

updateVirtualHost

@Indexable(type=REINDEX)
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

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

fetchVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost fetchVirtualHost(long companyId,
                                                                      long layoutSetId)
                             throws SystemException
Throws:
SystemException

fetchVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost fetchVirtualHost(String hostname)
                             throws SystemException
Throws:
SystemException

getVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost getVirtualHost(long companyId,
                                                                    long layoutSetId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

getVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost getVirtualHost(String hostname)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateVirtualHost

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

Liferay 6.2-ce-ga5