com.liferay.portal.service.http

Class RegionServiceSoap

Object

com.liferay.portal.service.http.RegionServiceSoap

public class RegionServiceSoap
extends Object

Provides the SOAP utility for the RegionServiceUtil service utility. The static methods of this class call the same methods of the service utility. However, the signatures are different because it is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to an array of com.liferay.portal.kernel.model.RegionSoap. If the method in the service utility returns a com.liferay.portal.kernel.model.Region, that is translated to a com.liferay.portal.kernel.model.RegionSoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

RegionServiceHttp

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
RegionServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.portal.kernel.model.RegionSoap	addRegion(long countryId, String regionCode, String name, boolean active)
static com.liferay.portal.kernel.model.RegionSoap	fetchRegion(long regionId)
static com.liferay.portal.kernel.model.RegionSoap	fetchRegion(long countryId, String regionCode)
static com.liferay.portal.kernel.model.RegionSoap	getRegion(long regionId)
static com.liferay.portal.kernel.model.RegionSoap	getRegion(long countryId, String regionCode)
static com.liferay.portal.kernel.model.RegionSoap[]	getRegions()
static com.liferay.portal.kernel.model.RegionSoap[]	getRegions(boolean active)
static com.liferay.portal.kernel.model.RegionSoap[]	getRegions(long countryId)
static com.liferay.portal.kernel.model.RegionSoap[]	getRegions(long countryId, boolean active)

Methods inherited from class Object

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

Constructor Detail

RegionServiceSoap

public RegionServiceSoap()

Method Detail

addRegion

public static com.liferay.portal.kernel.model.RegionSoap addRegion(long countryId,
                                                                   String regionCode,
                                                                   String name,
                                                                   boolean active)
                                                            throws RemoteException

Throws:

RemoteException

fetchRegion

public static com.liferay.portal.kernel.model.RegionSoap fetchRegion(long regionId)
                                                              throws RemoteException

Throws:

RemoteException

fetchRegion

public static com.liferay.portal.kernel.model.RegionSoap fetchRegion(long countryId,
                                                                     String regionCode)
                                                              throws RemoteException

Throws:

RemoteException

getRegion

public static com.liferay.portal.kernel.model.RegionSoap getRegion(long regionId)
                                                            throws RemoteException

Throws:

RemoteException

getRegion

public static com.liferay.portal.kernel.model.RegionSoap getRegion(long countryId,
                                                                   String regionCode)
                                                            throws RemoteException

Throws:

RemoteException

getRegions

public static com.liferay.portal.kernel.model.RegionSoap[] getRegions()
                                                               throws RemoteException

Throws:

RemoteException

getRegions

public static com.liferay.portal.kernel.model.RegionSoap[] getRegions(boolean active)
                                                               throws RemoteException

Throws:

RemoteException

getRegions

public static com.liferay.portal.kernel.model.RegionSoap[] getRegions(long countryId)
                                                               throws RemoteException

Throws:

RemoteException

getRegions

public static com.liferay.portal.kernel.model.RegionSoap[] getRegions(long countryId,
                                                                      boolean active)
                                                               throws RemoteException

Throws:

RemoteException