Liferay 7.0-ce-b4

com.liferay.portal.service
Interface VirtualHostLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
VirtualHostLocalServiceBaseImpl, VirtualHostLocalServiceImpl, 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, VirtualHostLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 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()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 VirtualHost fetchVirtualHost(long virtualHostId)
           
 VirtualHost fetchVirtualHost(long companyId, long layoutSetId)
           
 VirtualHost fetchVirtualHost(String hostname)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 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.
 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)
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

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteVirtualHost

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

deleteVirtualHost

@Indexable(type=DELETE)
VirtualHost deleteVirtualHost(long virtualHostId)
                              throws PortalException
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

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

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

dynamicQuery

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost fetchVirtualHost(long companyId,
                                                                      long layoutSetId)

fetchVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost fetchVirtualHost(String hostname)

fetchVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost fetchVirtualHost(long virtualHostId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

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

getVirtualHost

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

getVirtualHost

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

getVirtualHost

@Transactional(propagation=SUPPORTS,
               readOnly=true)
VirtualHost getVirtualHost(long virtualHostId)
                           throws PortalException
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

getVirtualHosts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<VirtualHost> getVirtualHosts(int start,
                                                                           int end)
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

getVirtualHostsCount

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

Returns:
the number of virtual hosts

updateVirtualHost

VirtualHost updateVirtualHost(long companyId,
                              long layoutSetId,
                              String hostname)

updateVirtualHost

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

Liferay 7.0-ce-b4