Interface VirtualHostLocalService
- All Superinterfaces:
BaseLocalService
,CTService<VirtualHost>
,PersistedModelLocalService
- All Known Implementing Classes:
VirtualHostLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddVirtualHost
(VirtualHost virtualHost) Adds the virtual host to the database.createPersistedModel
(Serializable primaryKeyObj) createVirtualHost
(long virtualHostId) Creates a new virtual host with the primary key.deletePersistedModel
(PersistedModel persistedModel) deleteVirtualHost
(long virtualHostId) Deletes the virtual host with the primary key from the database.deleteVirtualHost
(VirtualHost virtualHost) Deletes the virtual host from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchVirtualHost
(long virtualHostId) fetchVirtualHost
(long companyId, long layoutSetId) Deprecated.fetchVirtualHost
(String hostname) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getVirtualHost
(long virtualHostId) Returns the virtual host with the primary key.getVirtualHost
(long companyId, long layoutSetId) Deprecated.As of Mueller (7.2.x), replaced bygetVirtualHosts(long, long)
getVirtualHost
(String hostname) getVirtualHosts
(int start, int end) Returns a range of all the virtual hosts.getVirtualHosts
(long companyId) getVirtualHosts
(long companyId, long layoutSetId) int
Returns the number of virtual hosts.long
getVirtualHostsCount
(long excludedLayoutSetId, String[] virtualHostNames) updateVirtualHost
(long companyId, long layoutSetId, String hostname) Deprecated.As of Mueller (7.2.x), replaced byupdateVirtualHosts(long, long, TreeMap)
updateVirtualHost
(VirtualHost virtualHost) Updates the virtual host in the database or adds it if it does not yet exist.updateVirtualHosts
(long companyId, long layoutSetId, TreeMap<String, String> hostnames) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<VirtualHost>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addVirtualHost
Adds the virtual host to the database. Also notifies the appropriate model listeners.Important: Inspect VirtualHostLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
virtualHost
- the virtual host- Returns:
- the virtual host that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createVirtualHost
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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteVirtualHost
Deletes the virtual host with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect VirtualHostLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deleteVirtualHost
Deletes the virtual host from the database. Also notifies the appropriate model listeners.Important: Inspect VirtualHostLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
virtualHost
- the virtual host- Returns:
- the virtual host that was removed
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.VirtualHostModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.VirtualHostModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- 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 virtualHostId) -
fetchVirtualHost
@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) VirtualHost fetchVirtualHost(long companyId, long layoutSetId) Deprecated.As of Mueller (7.2.x), replaced bygetVirtualHosts(long, long)
-
fetchVirtualHost
-
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 interfacePersistedModelLocalService
- 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
-
getVirtualHost
@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) VirtualHost getVirtualHost(long companyId, long layoutSetId) throws PortalException Deprecated.As of Mueller (7.2.x), replaced bygetVirtualHosts(long, long)
- Throws:
PortalException
-
getVirtualHost
@Transactional(propagation=SUPPORTS, readOnly=true) VirtualHost getVirtualHost(String hostname) throws PortalException - Throws:
PortalException
-
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.VirtualHostModelImpl
.- Parameters:
start
- the lower bound of the range of virtual hostsend
- the upper bound of the range of virtual hosts (not inclusive)- Returns:
- the range of virtual hosts
-
getVirtualHosts
@Transactional(propagation=SUPPORTS, readOnly=true) List<VirtualHost> getVirtualHosts(long companyId) -
getVirtualHosts
@Transactional(propagation=SUPPORTS, readOnly=true) List<VirtualHost> getVirtualHosts(long companyId, long layoutSetId) -
getVirtualHostsCount
Returns the number of virtual hosts.- Returns:
- the number of virtual hosts
-
getVirtualHostsCount
@Transactional(propagation=SUPPORTS, readOnly=true) long getVirtualHostsCount(long excludedLayoutSetId, String[] virtualHostNames) -
updateVirtualHost
Deprecated.As of Mueller (7.2.x), replaced byupdateVirtualHosts(long, long, TreeMap)
-
updateVirtualHost
Updates the virtual host in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect VirtualHostLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
virtualHost
- the virtual host- Returns:
- the virtual host that was updated
-
updateVirtualHosts
List<VirtualHost> updateVirtualHosts(long companyId, long layoutSetId, TreeMap<String, String> hostnames) -
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<VirtualHost>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<VirtualHost>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<VirtualHost>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<VirtualHost>
- Throws:
E extends Throwable
-
getVirtualHosts(long, long)