com.liferay.portal.service.http

Class EmailAddressServiceSoap

Object

com.liferay.portal.service.http.EmailAddressServiceSoap

@ProviderType
public class EmailAddressServiceSoap
extends Object

Provides the SOAP utility for the EmailAddressServiceUtil service utility. The static methods of this class calls 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 List, that is translated to an array of EmailAddressSoap. If the method in the service utility returns a EmailAddress, that is translated to a EmailAddressSoap. 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:

EmailAddressServiceHttp, EmailAddressSoap, EmailAddressServiceUtil

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
EmailAddressServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.portal.kernel.model.EmailAddressSoap	addEmailAddress(String className, long classPK, String address, long typeId, boolean primary, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	deleteEmailAddress(long emailAddressId)
static com.liferay.portal.kernel.model.EmailAddressSoap	fetchEmailAddress(long emailAddressId) Returns the email address with the primary key.
static com.liferay.portal.kernel.model.EmailAddressSoap	getEmailAddress(long emailAddressId)
static com.liferay.portal.kernel.model.EmailAddressSoap[]	getEmailAddresses(String className, long classPK)
static com.liferay.portal.kernel.model.EmailAddressSoap	updateEmailAddress(long emailAddressId, String address, long typeId, boolean primary)

Methods inherited from class Object

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

Constructor Detail

EmailAddressServiceSoap

public EmailAddressServiceSoap()

Method Detail

addEmailAddress

public static com.liferay.portal.kernel.model.EmailAddressSoap addEmailAddress(String className,
                                                                               long classPK,
                                                                               String address,
                                                                               long typeId,
                                                                               boolean primary,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws RemoteException

Throws:

RemoteException

deleteEmailAddress

public static void deleteEmailAddress(long emailAddressId)
                               throws RemoteException

Throws:

RemoteException

fetchEmailAddress

public static com.liferay.portal.kernel.model.EmailAddressSoap fetchEmailAddress(long emailAddressId)
                                                                          throws RemoteException

Returns the email address with the primary key.

Parameters:

emailAddressId - the primary key of the email address

Returns:

the email address with the primary key, or null if an email address with the primary key could not be found or if the user did not have permission to view the email address

Throws:

RemoteException

getEmailAddress

public static com.liferay.portal.kernel.model.EmailAddressSoap getEmailAddress(long emailAddressId)
                                                                        throws RemoteException

Throws:

RemoteException

getEmailAddresses

public static com.liferay.portal.kernel.model.EmailAddressSoap[] getEmailAddresses(String className,
                                                                                   long classPK)
                                                                            throws RemoteException

Throws:

RemoteException

updateEmailAddress

public static com.liferay.portal.kernel.model.EmailAddressSoap updateEmailAddress(long emailAddressId,
                                                                                  String address,
                                                                                  long typeId,
                                                                                  boolean primary)
                                                                           throws RemoteException

Throws:

RemoteException