|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.AddressLocalServiceUtil
public class AddressLocalServiceUtil
The utility for the address local service. This utility wraps AddressLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
Never modify this class directly. Add custom service methods to AddressLocalServiceImpl
and rerun ServiceBuilder to regenerate this class.
This is a local service. 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.
AddressLocalService
,
AddressLocalServiceBaseImpl
,
AddressLocalServiceImpl
Constructor Summary | |
---|---|
AddressLocalServiceUtil()
|
Method Summary | |
---|---|
static Address |
addAddress(Address address)
Adds the address to the database. |
static 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)
|
static Address |
createAddress(long addressId)
Creates a new address with the primary key. |
static void |
deleteAddress(Address address)
Deletes the address from the database. |
static void |
deleteAddress(long addressId)
Deletes the address with the primary key from the database. |
static void |
deleteAddresses(long companyId,
String className,
long classPK)
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static 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. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Counts the number of rows that match the dynamic query. |
static Address |
getAddress(long addressId)
Gets the address with the primary key. |
static List<Address> |
getAddresses()
|
static List<Address> |
getAddresses(int start,
int end)
Gets a range of all the addresses. |
static List<Address> |
getAddresses(long companyId,
String className,
long classPK)
|
static int |
getAddressesCount()
Gets the number of addresses. |
static AddressLocalService |
getService()
|
void |
setService(AddressLocalService service)
|
static Address |
updateAddress(Address address)
Updates the address in the database. |
static Address |
updateAddress(Address address,
boolean merge)
Updates the address in the database. |
static Address |
updateAddress(long addressId,
String street1,
String street2,
String street3,
String city,
String zip,
long regionId,
long countryId,
int typeId,
boolean mailing,
boolean primary)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AddressLocalServiceUtil()
Method Detail |
---|
public static Address addAddress(Address address) throws SystemException
address
- the address to add
SystemException
- if a system exception occurredpublic static Address createAddress(long addressId)
addressId
- the primary key for the new address
public static void deleteAddress(long addressId) throws PortalException, SystemException
addressId
- the primary key of the address to delete
PortalException
- if a address with the primary key could not be found
SystemException
- if a system exception occurredpublic static void deleteAddress(Address address) throws SystemException
address
- the address to delete
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static Address getAddress(long addressId) throws PortalException, SystemException
addressId
- the primary key of the address to get
PortalException
- if a address with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<Address> getAddresses(int start, int end) throws SystemException
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.
start
- the lower bound of the range of addresses to returnend
- the upper bound of the range of addresses to return (not inclusive)
SystemException
- if a system exception occurredpublic static int getAddressesCount() throws SystemException
SystemException
- if a system exception occurredpublic static Address updateAddress(Address address) throws SystemException
address
- the address to update
SystemException
- if a system exception occurredpublic static Address updateAddress(Address address, boolean merge) throws SystemException
address
- the address to updatemerge
- whether to merge the address with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic static 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
PortalException
SystemException
public static void deleteAddresses(long companyId, String className, long classPK) throws SystemException
SystemException
public static List<Address> getAddresses() throws SystemException
SystemException
public static List<Address> getAddresses(long companyId, String className, long classPK) throws SystemException
SystemException
public static 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
PortalException
SystemException
public static AddressLocalService getService()
public void setService(AddressLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |