Interface AddressLocalService
- All Superinterfaces:
BaseLocalService
,CTService<Address>
,PersistedModelLocalService
- All Known Implementing Classes:
AddressLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddAddress
(Address address) Adds the address to the database.addAddress
(String externalReferenceCode, long userId, String className, long classPK, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary, String phoneNumber, ServiceContext serviceContext) copyAddress
(long sourceAddressId, String className, long classPK, ServiceContext serviceContext) createAddress
(long addressId) Creates a new address with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteAddress
(long addressId) Deletes the address with the primary key from the database.deleteAddress
(Address address) Deletes the address from the database.void
deleteAddresses
(long companyId, String className, long classPK) void
deleteCountryAddresses
(long countryId) deletePersistedModel
(PersistedModel persistedModel) void
deleteRegionAddresses
(long regionId) <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.fetchAddress
(long addressId) fetchAddressByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchAddressByUuidAndCompanyId
(String uuid, long companyId) Returns the address with the matching UUID and company.getAddress
(long addressId) Returns the address with the primary key.getAddressByExternalReferenceCode
(String externalReferenceCode, long companyId) getAddressByUuidAndCompanyId
(String uuid, long companyId) Returns the address with the matching UUID and company.getAddresses
(int start, int end) Returns a range of all the addresses.getAddresses
(long companyId, String className, long classPK) getAddresses
(long companyId, String className, long classPK, int start, int end, OrderByComparator<Address> orderByComparator) int
Returns the number of addresses.int
getAddressesCount
(long companyId, String className, long classPK) getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getListTypeAddresses
(long companyId, String className, long classPK, long[] listTypeIds) getListTypeAddresses
(long companyId, String className, long classPK, long[] listTypeIds, int start, int end, OrderByComparator<Address> orderByComparator) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) searchAddresses
(long companyId, String className, long classPK, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) updateAddress
(long addressId, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary) updateAddress
(long addressId, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary, String phoneNumber) updateAddress
(Address address) Updates the address in the database or adds it if it does not yet exist.updateExternalReferenceCode
(long addressId, String externalReferenceCode) updateExternalReferenceCode
(Address address, String externalReferenceCode) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<Address>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addAddress
Adds the address to the database. Also notifies the appropriate model listeners.Important: Inspect AddressLocalServiceImpl 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:
address
- the address- Returns:
- the address that was added
-
addAddress
@Indexable(type=REINDEX) Address addAddress(String externalReferenceCode, long userId, String className, long classPK, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary, String phoneNumber, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
copyAddress
Address copyAddress(long sourceAddressId, String className, long classPK, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createAddress
Creates a new address with the primary key. Does not add the address to the database.- Parameters:
addressId
- the primary key for the new address- Returns:
- the new address
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteAddress
Deletes the address from the database. Also notifies the appropriate model listeners.Important: Inspect AddressLocalServiceImpl 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:
address
- the address- Returns:
- the address that was removed
-
deleteAddress
Deletes the address with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect AddressLocalServiceImpl 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:
addressId
- the primary key of the address- Returns:
- the address that was removed
- Throws:
PortalException
- if a address with the primary key could not be found
-
deleteAddresses
-
deleteCountryAddresses
void deleteCountryAddresses(long countryId) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteRegionAddresses
void deleteRegionAddresses(long regionId) -
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.AddressModelImpl
.- 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.AddressModelImpl
.- 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
-
fetchAddress
-
fetchAddressByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Address fetchAddressByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchAddressByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Address fetchAddressByUuidAndCompanyId(String uuid, long companyId) Returns the address with the matching UUID and company.- Parameters:
uuid
- the address's UUIDcompanyId
- the primary key of the company- Returns:
- the matching address, or
null
if a matching address could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getAddress
@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddress(long addressId) throws PortalException Returns the address with the primary key.- Parameters:
addressId
- the primary key of the address- Returns:
- the address
- Throws:
PortalException
- if a address with the primary key could not be found
-
getAddressByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getAddressByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddressByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the address with the matching UUID and company.- Parameters:
uuid
- the address's UUIDcompanyId
- the primary key of the company- Returns:
- the matching address
- Throws:
PortalException
- if a matching address could not be found
-
getAddresses
-
getAddresses
Returns a range of all the addresses.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.AddressModelImpl
.- Parameters:
start
- the lower bound of the range of addressesend
- the upper bound of the range of addresses (not inclusive)- Returns:
- the range of addresses
-
getAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses(long companyId, String className, long classPK) -
getAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses(long companyId, String className, long classPK, int start, int end, OrderByComparator<Address> orderByComparator) -
getAddressesCount
Returns the number of addresses.- Returns:
- the number of addresses
-
getAddressesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getAddressesCount(long companyId, String className, long classPK) -
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getListTypeAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds) -
getListTypeAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds, int start, int end, OrderByComparator<Address> orderByComparator) -
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
-
searchAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) BaseModelSearchResult<Address> searchAddresses(long companyId, String className, long classPK, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) throws PortalException- Throws:
PortalException
-
updateAddress
Updates the address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect AddressLocalServiceImpl 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:
address
- the address- Returns:
- the address that was updated
-
updateAddress
Address updateAddress(long addressId, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary) throws PortalException - Throws:
PortalException
-
updateAddress
@Indexable(type=REINDEX) Address updateAddress(long addressId, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary, String phoneNumber) throws PortalException - Throws:
PortalException
-
updateExternalReferenceCode
Address updateExternalReferenceCode(Address address, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateExternalReferenceCode
Address updateExternalReferenceCode(long addressId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<Address>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<Address>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Address>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<Address>
- Throws:
E extends Throwable
-