Package com.liferay.portal.kernel.service

Interface RegionService

All Superinterfaces:

BaseService

All Known Implementing Classes:

RegionServiceWrapper

@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface RegionService
extends BaseService

Provides the remote service interface for Region. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

• RegionServiceUtil

Generated:

Method Summary

Modifier and Type	Method	Description
Region	addRegion(String externalReferenceCode, long countryId, boolean active, String name, double position, String regionCode, ServiceContext serviceContext)
void	deleteRegion(long regionId)
Region	fetchRegion(long regionId)
Region	fetchRegion(long countryId, String regionCode)
Region	fetchRegionByExternalReferenceCode(String externalReferenceCode, long companyId)
String	getOSGiServiceIdentifier()	Returns the OSGi service identifier.
Region	getRegion(long regionId)
Region	getRegion(long countryId, String regionCode)
Region	getRegionByExternalReferenceCode(String externalReferenceCode, long companyId)
List<Region>	getRegions()
List<Region>	getRegions(boolean active)
List<Region>	getRegions(long countryId)
List<Region>	getRegions(long countryId, boolean active)
List<Region>	getRegions(long countryId, boolean active, int start, int end, OrderByComparator<Region> orderByComparator)
List<Region>	getRegions(long countryId, int start, int end, OrderByComparator<Region> orderByComparator)
List<Region>	getRegions(long companyId, String a2, boolean active)
int	getRegionsCount(long countryId)
int	getRegionsCount(long countryId, boolean active)
BaseModelSearchResult<Region>	searchRegions(long companyId, Boolean active, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Region> orderByComparator)
Region	updateActive(long regionId, boolean active)
Region	updateRegion(String externalReferenceCode, long regionId, boolean active, String name, double position, String regionCode)

Method Details

addRegion

Region addRegion(String externalReferenceCode,
 long countryId,
 boolean active,
 String name,
 double position,
 String regionCode,
 ServiceContext serviceContext)
          throws PortalException

Throws:

PortalException

deleteRegion

void deleteRegion(long regionId)
           throws PortalException

Throws:

PortalException

fetchRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Region fetchRegion(long regionId)

fetchRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Region fetchRegion(long countryId,
 String regionCode)

fetchRegionByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Region fetchRegionByExternalReferenceCode(String externalReferenceCode,
 long companyId)
                                   throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Region getRegion(long regionId)
          throws PortalException

Throws:

PortalException

getRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Region getRegion(long countryId,
 String regionCode)
          throws PortalException

Throws:

PortalException

getRegionByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Region getRegionByExternalReferenceCode(String externalReferenceCode,
 long companyId)
                                 throws PortalException

Throws:

PortalException

getRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions()

getRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions(boolean active)

getRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions(long countryId)

getRegions

@AccessControlled(guestAccessEnabled=true)
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions(long countryId,
 boolean active)

getRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions(long countryId,
 boolean active,
 int start,
 int end,
 OrderByComparator<Region> orderByComparator)

getRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions(long countryId,
 int start,
 int end,
 OrderByComparator<Region> orderByComparator)

getRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Region> getRegions(long companyId,
 String a2,
 boolean active)
                 throws PortalException

Throws:

PortalException

getRegionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRegionsCount(long countryId)

getRegionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRegionsCount(long countryId,
 boolean active)

searchRegions

@JSONWebService(mode=IGNORE)
@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<Region> searchRegions(long companyId,
 Boolean active,
 String keywords,
 LinkedHashMap<String,Object> params,
 int start,
 int end,
 OrderByComparator<Region> orderByComparator)
                                     throws PortalException

Throws:

PortalException

updateActive

Region updateActive(long regionId,
 boolean active)
             throws PortalException

Throws:

PortalException

updateRegion

Region updateRegion(String externalReferenceCode,
 long regionId,
 boolean active,
 String name,
 double position,
 String regionCode)
             throws PortalException

Throws:

PortalException