com.liferay.portal.kernel.service

Class RegionServiceUtil

Object

com.liferay.portal.kernel.service.RegionServiceUtil

public class RegionServiceUtil
extends Object

Provides the remote service utility for Region. This utility wraps com.liferay.portal.service.impl.RegionServiceImpl and is an access point for service operations in application layer code running on a remote server. 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:

RegionService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
RegionServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Region	addRegion(long countryId, String regionCode, String name, boolean active) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
static Region	fetchRegion(long regionId)
static Region	fetchRegion(long countryId, String regionCode)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static Region	getRegion(long regionId)
static Region	getRegion(long countryId, String regionCode)
static List<Region>	getRegions()
static List<Region>	getRegions(boolean active)
static List<Region>	getRegions(long countryId)
static List<Region>	getRegions(long countryId, boolean active)
static RegionService	getService()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegionServiceUtil

public RegionServiceUtil()

Method Detail

addRegion

public static Region addRegion(long countryId,
                               String regionCode,
                               String name,
                               boolean active)
                        throws PortalException

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use RegionServiceUtil to access the region remote service. Add custom service methods to com.liferay.portal.service.impl.RegionServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

fetchRegion

public static Region fetchRegion(long regionId)

fetchRegion

public static Region fetchRegion(long countryId,
                                 String regionCode)

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getRegion

public static Region getRegion(long regionId)
                        throws PortalException

Throws:

PortalException

getRegion

public static Region getRegion(long countryId,
                               String regionCode)
                        throws PortalException

Throws:

PortalException

getRegions

public static List<Region> getRegions()

getRegions

public static List<Region> getRegions(boolean active)

getRegions

public static List<Region> getRegions(long countryId)

getRegions

public static List<Region> getRegions(long countryId,
                                      boolean active)

getService

public static RegionService getService()