Interface PhoneLocalService
- All Superinterfaces:
BaseLocalService
,CTService<Phone>
,PersistedModelLocalService
- All Known Implementing Classes:
PhoneLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionAdds the phone to the database.addPhone
(String externalReferenceCode, long userId, String className, long classPK, String number, String extension, long listTypeId, boolean primary, ServiceContext serviceContext) createPersistedModel
(Serializable primaryKeyObj) createPhone
(long phoneId) Creates a new phone with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePhone
(long phoneId) Deletes the phone with the primary key from the database.deletePhone
(Phone phone) Deletes the phone from the database.void
deletePhones
(long companyId, String className, long classPK) <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.fetchPhone
(long phoneId) fetchPhoneByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchPhoneByUuidAndCompanyId
(String uuid, long companyId) Returns the phone with the matching UUID and company.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPhone
(long phoneId) Returns the phone with the primary key.getPhoneByExternalReferenceCode
(String externalReferenceCode, long companyId) getPhoneByUuidAndCompanyId
(String uuid, long companyId) Returns the phone with the matching UUID and company.getPhones
(int start, int end) Returns a range of all the phones.int
Returns the number of phones.updatePhone
(Phone phone) Updates the phone in the database or adds it if it does not yet exist.updatePhone
(String externalReferenceCode, long phoneId, String number, String extension, long listTypeId, boolean primary) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<Phone>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addPhone
Adds the phone to the database. Also notifies the appropriate model listeners.Important: Inspect PhoneLocalServiceImpl 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:
phone
- the phone- Returns:
- the phone that was added
-
addPhone
Phone addPhone(String externalReferenceCode, long userId, String className, long classPK, String number, String extension, long listTypeId, boolean primary, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createPhone
Creates a new phone with the primary key. Does not add the phone to the database.- Parameters:
phoneId
- the primary key for the new phone- Returns:
- the new phone
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deletePhone
Deletes the phone with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PhoneLocalServiceImpl 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:
phoneId
- the primary key of the phone- Returns:
- the phone that was removed
- Throws:
PortalException
- if a phone with the primary key could not be found
-
deletePhone
Deletes the phone from the database. Also notifies the appropriate model listeners.Important: Inspect PhoneLocalServiceImpl 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:
phone
- the phone- Returns:
- the phone that was removed
-
deletePhones
-
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.PhoneModelImpl
.- 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.PhoneModelImpl
.- 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
-
fetchPhone
-
fetchPhoneByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Phone fetchPhoneByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchPhoneByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Phone fetchPhoneByUuidAndCompanyId(String uuid, long companyId) Returns the phone with the matching UUID and company.- Parameters:
uuid
- the phone's UUIDcompanyId
- the primary key of the company- Returns:
- the matching phone, or
null
if a matching phone could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
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
-
getPhone
@Transactional(propagation=SUPPORTS, readOnly=true) Phone getPhone(long phoneId) throws PortalException Returns the phone with the primary key.- Parameters:
phoneId
- the primary key of the phone- Returns:
- the phone
- Throws:
PortalException
- if a phone with the primary key could not be found
-
getPhoneByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Phone getPhoneByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getPhoneByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Phone getPhoneByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the phone with the matching UUID and company.- Parameters:
uuid
- the phone's UUIDcompanyId
- the primary key of the company- Returns:
- the matching phone
- Throws:
PortalException
- if a matching phone could not be found
-
getPhones
-
getPhones
Returns a range of all the phones.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.PhoneModelImpl
.- Parameters:
start
- the lower bound of the range of phonesend
- the upper bound of the range of phones (not inclusive)- Returns:
- the range of phones
-
getPhones
@Transactional(propagation=SUPPORTS, readOnly=true) List<Phone> getPhones(long companyId, String className, long classPK) -
getPhonesCount
Returns the number of phones.- Returns:
- the number of phones
-
updatePhone
Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PhoneLocalServiceImpl 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:
phone
- the phone- Returns:
- the phone that was updated
-
updatePhone
Phone updatePhone(String externalReferenceCode, long phoneId, String number, String extension, long listTypeId, boolean primary) throws PortalException - Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<Phone>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<Phone>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Phone>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<Phone>
- Throws:
E extends Throwable
-