Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface AddressLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AddressLocalServiceBaseImpl, AddressLocalServiceImpl, AddressLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AddressLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for Address. 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.

See Also:
AddressLocalServiceUtil, AddressLocalServiceBaseImpl, AddressLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Address addAddress(Address address)
          Adds the address to the database.
 Address addAddress(long userId, String className, long classPK, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, int typeId, boolean mailing, boolean primary)
          Deprecated. As of 6.2.0, replaced by addAddress(long, String, long, String, String, String, String, String, long, long, int, boolean, boolean, ServiceContext)
 Address addAddress(long userId, String className, long classPK, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, int typeId, boolean mailing, boolean primary, ServiceContext serviceContext)
           
 Address createAddress(long addressId)
          Creates a new address with the primary key.
 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)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 Address fetchAddress(long addressId)
           
 Address fetchAddressByUuidAndCompanyId(String uuid, long companyId)
          Returns the address with the matching UUID and company.
 Address getAddress(long addressId)
          Returns the address with the primary key.
 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)
           
 int getAddressesCount()
          Returns the number of addresses.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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, int typeId, boolean mailing, boolean primary)
           
 

Method Detail

addAddress

@Indexable(type=REINDEX)
Address addAddress(Address address)
                   throws SystemException
Adds the address to the database. Also notifies the appropriate model listeners.

Parameters:
address - the address
Returns:
the address that was added
Throws:
SystemException - if a system exception occurred

createAddress

Address createAddress(long addressId)
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

deleteAddress

@Indexable(type=DELETE)
Address deleteAddress(long addressId)
                      throws PortalException,
                             SystemException
Deletes the address with the primary key from the database. Also notifies the appropriate model listeners.

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
SystemException - if a system exception occurred

deleteAddress

@Indexable(type=DELETE)
Address deleteAddress(Address address)
                      throws SystemException
Deletes the address from the database. Also notifies the appropriate model listeners.

Parameters:
address - the address
Returns:
the address that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AddressModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AddressModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Address fetchAddress(long addressId)
                     throws SystemException
Throws:
SystemException

fetchAddressByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Address fetchAddressByUuidAndCompanyId(String uuid,
                                                                                long companyId)
                                       throws SystemException
Returns the address with the matching UUID and company.

Parameters:
uuid - the address's UUID
companyId - the primary key of the company
Returns:
the matching address, or null if a matching address could not be found
Throws:
SystemException - if a system exception occurred

getAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Address getAddress(long addressId)
                   throws PortalException,
                          SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAddressByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Address getAddressByUuidAndCompanyId(String uuid,
                                                                              long companyId)
                                     throws PortalException,
                                            SystemException
Returns the address with the matching UUID and company.

Parameters:
uuid - the address's UUID
companyId - the primary key of the company
Returns:
the matching address
Throws:
PortalException - if a matching address could not be found
SystemException - if a system exception occurred

getAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Address> getAddresses(int start,
                                                                    int end)
                           throws SystemException
Returns a range of all the addresses.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AddressModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of addresses
end - the upper bound of the range of addresses (not inclusive)
Returns:
the range of addresses
Throws:
SystemException - if a system exception occurred

getAddressesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAddressesCount()
                      throws SystemException
Returns the number of addresses.

Returns:
the number of addresses
Throws:
SystemException - if a system exception occurred

updateAddress

@Indexable(type=REINDEX)
Address updateAddress(Address address)
                      throws SystemException
Updates the address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
address - the address
Returns:
the address that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addAddress

Address addAddress(long userId,
                   String className,
                   long classPK,
                   String street1,
                   String street2,
                   String street3,
                   String city,
                   String zip,
                   long regionId,
                   long countryId,
                   int typeId,
                   boolean mailing,
                   boolean primary)
                   throws PortalException,
                          SystemException
Deprecated. As of 6.2.0, replaced by addAddress(long, String, long, String, String, String, String, String, long, long, int, boolean, boolean, ServiceContext)

Throws:
PortalException
SystemException

addAddress

Address addAddress(long userId,
                   String className,
                   long classPK,
                   String street1,
                   String street2,
                   String street3,
                   String city,
                   String zip,
                   long regionId,
                   long countryId,
                   int typeId,
                   boolean mailing,
                   boolean primary,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

deleteAddresses

void deleteAddresses(long companyId,
                     String className,
                     long classPK)
                     throws SystemException
Throws:
SystemException

getAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Address> getAddresses()
                           throws SystemException
Throws:
SystemException

getAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Address> getAddresses(long companyId,
                                                                    String className,
                                                                    long classPK)
                           throws SystemException
Throws:
SystemException

updateAddress

Address updateAddress(long addressId,
                      String street1,
                      String street2,
                      String street3,
                      String city,
                      String zip,
                      long regionId,
                      long countryId,
                      int typeId,
                      boolean mailing,
                      boolean primary)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5