Class AddressLocalServiceUtil
com.liferay.portal.service.impl.AddressLocalServiceImpl and
is an access point for service operations in application layer code running
on the local server. 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AddressaddAddress(Address address) Adds the address to the database.static AddressaddAddress(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) static AddresscopyAddress(long sourceAddressId, String className, long classPK, ServiceContext serviceContext) static AddresscreateAddress(long addressId) Creates a new address with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static AddressdeleteAddress(long addressId) Deletes the address with the primary key from the database.static AddressdeleteAddress(Address address) Deletes the address from the database.static voiddeleteAddresses(long companyId, String className, long classPK) static voiddeleteCountryAddresses(long countryId) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static voiddeleteRegionAddresses(long regionId) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static AddressfetchAddress(long addressId) static AddressfetchAddressByExternalReferenceCode(String externalReferenceCode, long companyId) static AddressfetchAddressByUuidAndCompanyId(String uuid, long companyId) Returns the address with the matching UUID and company.static ActionableDynamicQuerystatic AddressgetAddress(long addressId) Returns the address with the primary key.static AddressgetAddressByExternalReferenceCode(String externalReferenceCode, long companyId) static AddressgetAddressByUuidAndCompanyId(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) static intReturns the number of addresses.static intgetAddressesCount(long companyId, String className, long classPK) static ExportActionableDynamicQuerygetExportActionableDynamicQuery(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) static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static AddressLocalServicestatic BaseModelSearchResult<Address>searchAddresses(long companyId, String className, long classPK, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) static voidsetService(AddressLocalService service) static AddressupdateAddress(long addressId, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary) static AddressupdateAddress(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) static AddressupdateAddress(Address address) Updates the address in the database or adds it if it does not yet exist.static AddressupdateExternalReferenceCode(long addressId, String externalReferenceCode) static AddressupdateExternalReferenceCode(Address address, String externalReferenceCode)
-
Constructor Details
-
AddressLocalServiceUtil
public AddressLocalServiceUtil()
-
-
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
public static 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
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static void deleteCountryAddresses(long countryId) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRegionAddresses
public static void deleteRegionAddresses(long regionId) -
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
public static <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchAddressByUuidAndCompanyId
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
nullif a matching address could not be found
-
getActionableDynamicQuery
-
getAddress
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
public static Address getAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getAddressByUuidAndCompanyId
public static 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
-
getAddresses
public static List<Address> getAddresses(long companyId, String className, long classPK, int start, int end, OrderByComparator<Address> orderByComparator) -
getAddressesCount
public static int getAddressesCount()Returns the number of addresses.- Returns:
- the number of addresses
-
getAddressesCount
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getListTypeAddresses
-
getListTypeAddresses
public static List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds, int start, int end, OrderByComparator<Address> orderByComparator) -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
searchAddresses
public static 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
public static 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
public static 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
public static Address updateExternalReferenceCode(Address address, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateExternalReferenceCode
public static Address updateExternalReferenceCode(long addressId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
getService
-
setService
-