Class AddressLocalServiceWrapper
- All Implemented Interfaces:
AddressLocalService
,BaseLocalService
,CTService<Address>
,PersistedModelLocalService
,ServiceWrapper<AddressLocalService>
AddressLocalService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
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) void
setWrappedService
(AddressLocalService addressLocalService) 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
AddressLocalServiceWrapper
public AddressLocalServiceWrapper() -
AddressLocalServiceWrapper
-
-
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.
- Specified by:
addAddress
in interfaceAddressLocalService
- Parameters:
address
- the address- Returns:
- the address that was added
-
addAddress
public 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 - Specified by:
addAddress
in interfaceAddressLocalService
- Throws:
PortalException
-
copyAddress
public Address copyAddress(long sourceAddressId, String className, long classPK, ServiceContext serviceContext) throws PortalException - Specified by:
copyAddress
in interfaceAddressLocalService
- Throws:
PortalException
-
createAddress
Creates a new address with the primary key. Does not add the address to the database.- Specified by:
createAddress
in interfaceAddressLocalService
- Parameters:
addressId
- the primary key for the new address- Returns:
- the new address
-
createPersistedModel
- Specified by:
createPersistedModel
in interfaceAddressLocalService
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
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.
- Specified by:
deleteAddress
in interfaceAddressLocalService
- 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.
- Specified by:
deleteAddress
in interfaceAddressLocalService
- 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 foundPortalException
-
deleteAddresses
- Specified by:
deleteAddresses
in interfaceAddressLocalService
-
deleteCountryAddresses
public void deleteCountryAddresses(long countryId) - Specified by:
deleteCountryAddresses
in interfaceAddressLocalService
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfaceAddressLocalService
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
PortalException
-
deleteRegionAddresses
public void deleteRegionAddresses(long regionId) - Specified by:
deleteRegionAddresses
in interfaceAddressLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfaceAddressLocalService
- Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfaceAddressLocalService
- Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
- Specified by:
dynamicQuery
in interfaceAddressLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in interfaceAddressLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
.- Specified by:
dynamicQuery
in interfaceAddressLocalService
- 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
public <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
.- Specified by:
dynamicQuery
in interfaceAddressLocalService
- 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
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceAddressLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceAddressLocalService
- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchAddress
- Specified by:
fetchAddress
in interfaceAddressLocalService
-
fetchAddressByExternalReferenceCode
- Specified by:
fetchAddressByExternalReferenceCode
in interfaceAddressLocalService
-
fetchAddressByUuidAndCompanyId
Returns the address with the matching UUID and company.- Specified by:
fetchAddressByUuidAndCompanyId
in interfaceAddressLocalService
- 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
- Specified by:
getActionableDynamicQuery
in interfaceAddressLocalService
-
getAddress
Returns the address with the primary key.- Specified by:
getAddress
in interfaceAddressLocalService
- Parameters:
addressId
- the primary key of the address- Returns:
- the address
- Throws:
PortalException
- if a address with the primary key could not be foundPortalException
-
getAddressByExternalReferenceCode
public Address getAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Specified by:
getAddressByExternalReferenceCode
in interfaceAddressLocalService
- Throws:
PortalException
-
getAddressByUuidAndCompanyId
Returns the address with the matching UUID and company.- Specified by:
getAddressByUuidAndCompanyId
in interfaceAddressLocalService
- 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 foundPortalException
-
getAddresses
- Specified by:
getAddresses
in interfaceAddressLocalService
-
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
.- Specified by:
getAddresses
in interfaceAddressLocalService
- 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
- Specified by:
getAddresses
in interfaceAddressLocalService
-
getAddresses
public List<Address> getAddresses(long companyId, String className, long classPK, int start, int end, OrderByComparator<Address> orderByComparator) - Specified by:
getAddresses
in interfaceAddressLocalService
-
getAddressesCount
public int getAddressesCount()Returns the number of addresses.- Specified by:
getAddressesCount
in interfaceAddressLocalService
- Returns:
- the number of addresses
-
getAddressesCount
- Specified by:
getAddressesCount
in interfaceAddressLocalService
-
getExportActionableDynamicQuery
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQuery
in interfaceAddressLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQuery
in interfaceAddressLocalService
-
getListTypeAddresses
public List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds) - Specified by:
getListTypeAddresses
in interfaceAddressLocalService
-
getListTypeAddresses
public List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds, int start, int end, OrderByComparator<Address> orderByComparator) - Specified by:
getListTypeAddresses
in interfaceAddressLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceAddressLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModel
in interfaceAddressLocalService
- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
PortalException
-
searchAddresses
public BaseModelSearchResult<Address> searchAddresses(long companyId, String className, long classPK, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) throws PortalException- Specified by:
searchAddresses
in interfaceAddressLocalService
- 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.
- Specified by:
updateAddress
in interfaceAddressLocalService
- Parameters:
address
- the address- Returns:
- the address that was updated
-
updateAddress
public 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 - Specified by:
updateAddress
in interfaceAddressLocalService
- Throws:
PortalException
-
updateAddress
public 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 - Specified by:
updateAddress
in interfaceAddressLocalService
- Throws:
PortalException
-
updateExternalReferenceCode
public Address updateExternalReferenceCode(Address address, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceAddressLocalService
- Throws:
PortalException
-
updateExternalReferenceCode
public Address updateExternalReferenceCode(long addressId, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceAddressLocalService
- Throws:
PortalException
-
getBasePersistence
- Specified by:
getBasePersistence
in interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceAddressLocalService
- Specified by:
getCTPersistence
in interfaceCTService<Address>
-
getModelClass
- Specified by:
getModelClass
in interfaceAddressLocalService
- Specified by:
getModelClass
in interfaceCTService<Address>
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Address>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceAddressLocalService
- Specified by:
updateWithUnsafeFunction
in interfaceCTService<Address>
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<AddressLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<AddressLocalService>
-