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:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddRegion
(long countryId, boolean active, String name, double position, String regionCode, ServiceContext serviceContext) void
deleteRegion
(long regionId) fetchRegion
(long regionId) fetchRegion
(long countryId, String regionCode) Returns the OSGi service identifier.getRegion
(long regionId) getRegions
(boolean active) getRegions
(long countryId) getRegions
(long countryId, boolean active) getRegions
(long countryId, boolean active, int start, int end, OrderByComparator<Region> orderByComparator) getRegions
(long countryId, int start, int end, OrderByComparator<Region> orderByComparator) getRegions
(long companyId, String a2, boolean active) int
getRegionsCount
(long countryId) int
getRegionsCount
(long countryId, boolean active) searchRegions
(long companyId, Boolean active, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Region> orderByComparator) updateActive
(long regionId, boolean active) updateRegion
(long regionId, boolean active, String name, double position, String regionCode)
-
Method Details
-
addRegion
Region addRegion(long countryId, boolean active, String name, double position, String regionCode, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deleteRegion
- Throws:
PortalException
-
fetchRegion
-
fetchRegion
@Transactional(propagation=SUPPORTS, readOnly=true) Region fetchRegion(long countryId, String regionCode) -
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
-
getRegions
-
getRegions
-
getRegions
-
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
-
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
- Throws:
PortalException
-
updateRegion
Region updateRegion(long regionId, boolean active, String name, double position, String regionCode) throws PortalException - Throws:
PortalException
-