@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface AddressLocalService extends BaseLocalService, CTService<Address>, PersistedModelLocalService
AddressLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
Address |
addAddress(Address address)
Adds the address to the database.
|
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) |
Address |
copyAddress(long sourceAddressId,
String className,
long classPK,
ServiceContext serviceContext) |
Address |
createAddress(long addressId)
Creates a new address with the primary key.
|
PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
Address |
deleteAddress(Address address)
Deletes the address from the database.
|
Address |
deleteAddress(long addressId)
Deletes the address with the primary key from the database.
|
void |
deleteAddresses(long companyId,
String className,
long classPK) |
void |
deleteCountryAddresses(long countryId) |
PersistedModel |
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) |
DynamicQuery |
dynamicQuery() |
<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.
|
Address |
fetchAddress(long addressId) |
Address |
fetchAddressByExternalReferenceCode(String externalReferenceCode,
long companyId) |
Address |
fetchAddressByUuidAndCompanyId(String uuid,
long companyId)
Returns the address with the matching UUID and company.
|
ActionableDynamicQuery |
getActionableDynamicQuery() |
Address |
getAddress(long addressId)
Returns the address with the primary key.
|
Address |
getAddressByExternalReferenceCode(String externalReferenceCode,
long companyId) |
Address |
getAddressByUuidAndCompanyId(String uuid,
long companyId)
Returns the address with the matching UUID and company.
|
List<Address> |
getAddresses() |
List<Address> |
getAddresses(int start,
int end)
Returns a range of all the addresses.
|
List<Address> |
getAddresses(long companyId,
String className,
long classPK) |
List<Address> |
getAddresses(long companyId,
String className,
long classPK,
int start,
int end,
OrderByComparator<Address> orderByComparator) |
int |
getAddressesCount()
Returns the number of addresses.
|
int |
getAddressesCount(long companyId,
String className,
long classPK) |
CTPersistence<Address> |
getCTPersistence() |
ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
List<Address> |
getListTypeAddresses(long companyId,
String className,
long classPK,
long[] listTypeIds) |
List<Address> |
getListTypeAddresses(long companyId,
String className,
long classPK,
long[] listTypeIds,
int start,
int end,
OrderByComparator<Address> orderByComparator) |
Class<Address> |
getModelClass() |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
BaseModelSearchResult<Address> |
searchAddresses(long companyId,
String className,
long classPK,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort) |
Address |
updateAddress(Address address)
Updates the address in the database or adds it if it does not yet exist.
|
Address |
updateAddress(long addressId,
String street1,
String street2,
String street3,
String city,
String zip,
long regionId,
long countryId,
long listTypeId,
boolean mailing,
boolean primary) |
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) |
<R,E extends Throwable> |
updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Address>,R,E> updateUnsafeFunction) |
fetchPersistedModel, getBasePersistence
@Indexable(type=REINDEX) Address addAddress(Address address)
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.
address
- the address@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
PortalException
Address copyAddress(long sourceAddressId, String className, long classPK, ServiceContext serviceContext) throws PortalException
PortalException
@Transactional(enabled=false) Address createAddress(long addressId)
addressId
- the primary key for the new addressPersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
createPersistedModel
in interface PersistedModelLocalService
PortalException
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) Address deleteAddress(Address address)
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.
address
- the address@Indexable(type=DELETE) Address deleteAddress(long addressId) throws PortalException
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.
addressId
- the primary key of the addressPortalException
- if a address with the primary key could not be foundvoid deleteAddresses(long companyId, String className, long classPK)
void deleteCountryAddresses(long countryId)
PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
void deleteRegionAddresses(long regionId)
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.AddressModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.AddressModelImpl
.
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 (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) Address fetchAddress(long addressId)
@Transactional(propagation=SUPPORTS, readOnly=true) Address fetchAddressByExternalReferenceCode(String externalReferenceCode, long companyId)
@Transactional(propagation=SUPPORTS, readOnly=true) Address fetchAddressByUuidAndCompanyId(String uuid, long companyId)
uuid
- the address's UUIDcompanyId
- the primary key of the companynull
if a matching address could not be found@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddress(long addressId) throws PortalException
addressId
- the primary key of the addressPortalException
- if a address with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddressByUuidAndCompanyId(String uuid, long companyId) throws PortalException
uuid
- the address's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching address could not be found@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.AddressModelImpl
.
start
- the lower bound of the range of addressesend
- the upper bound of the range of addresses (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses(long companyId, String className, long classPK)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses(long companyId, String className, long classPK, int start, int end, OrderByComparator<Address> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) int getAddressesCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getAddressesCount(long companyId, String className, long classPK)
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds, int start, int end, OrderByComparator<Address> orderByComparator)
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
@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
PortalException
@Indexable(type=REINDEX) Address updateAddress(Address address)
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.
address
- the addressAddress 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
PortalException
@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
PortalException
@Transactional(enabled=false) CTPersistence<Address> getCTPersistence()
getCTPersistence
in interface CTService<Address>
@Transactional(enabled=false) Class<Address> getModelClass()
getModelClass
in interface CTService<Address>
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Address>,R,E> updateUnsafeFunction) throws E extends Throwable
updateWithUnsafeFunction
in interface CTService<Address>
E extends Throwable