com.liferay.portal.service.http

Class OrganizationServiceSoap

java.lang.Object

com.liferay.portal.service.http.OrganizationServiceSoap

public class OrganizationServiceSoap
extends java.lang.Object

Provides the SOAP utility for the OrganizationServiceUtil 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.OrganizationSoap. If the method in the service utility returns a com.liferay.portal.kernel.model.Organization, that is translated to a com.liferay.portal.kernel.model.OrganizationSoap. 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:

OrganizationServiceHttp

Generated:

Constructor Summary

Constructors

Constructor and Description
OrganizationServiceSoap()

Method Summary

Modifier and Type	Method and Description
static void	addGroupOrganizations(long groupId, long[] organizationIds) Adds the organizations to the group.
static com.liferay.portal.kernel.model.OrganizationSoap	addOrganization(long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean site, com.liferay.portal.kernel.model.AddressSoap[] addresses, com.liferay.portal.kernel.model.EmailAddressSoap[] emailAddresses, com.liferay.portal.kernel.model.OrgLaborSoap[] orgLabors, com.liferay.portal.kernel.model.PhoneSoap[] phones, com.liferay.portal.kernel.model.WebsiteSoap[] websites, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds an organization with additional parameters.
static com.liferay.portal.kernel.model.OrganizationSoap	addOrganization(long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean site, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds an organization.
static void	addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Assigns the password policy to the organizations, removing any other currently assigned password policies.
static void	deleteLogo(long organizationId) Deletes the organization's logo.
static void	deleteOrganization(long organizationId) Deletes the organization.
static com.liferay.portal.kernel.model.OrganizationSoap	fetchOrganization(long organizationId) Returns the organization with the primary key.
static com.liferay.portal.kernel.model.OrganizationSoap[]	getGtOrganizations(long gtOrganizationId, long companyId, long parentOrganizationId, int size)
static com.liferay.portal.kernel.model.OrganizationSoap	getOrganization(long organizationId) Returns the organization with the primary key.
static long	getOrganizationId(long companyId, java.lang.String name) Returns the primary key of the organization with the name.
static com.liferay.portal.kernel.model.OrganizationSoap[]	getOrganizations(long companyId, long parentOrganizationId) Returns all the organizations belonging to the parent organization.
static com.liferay.portal.kernel.model.OrganizationSoap[]	getOrganizations(long companyId, long parentOrganizationId, int start, int end) Returns a range of all the organizations belonging to the parent organization.
static com.liferay.portal.kernel.model.OrganizationSoap[]	getOrganizations(long companyId, long parentOrganizationId, java.lang.String name, int start, int end)
static int	getOrganizationsCount(long companyId, long parentOrganizationId) Returns the number of organizations belonging to the parent organization.
static int	getOrganizationsCount(long companyId, long parentOrganizationId, java.lang.String name)
static com.liferay.portal.kernel.model.OrganizationSoap[]	getUserOrganizations(long userId) Returns all the organizations with which the user is explicitly associated.
static void	setGroupOrganizations(long groupId, long[] organizationIds) Sets the organizations in the group, removing and adding organizations to the group as necessary.
static void	unsetGroupOrganizations(long groupId, long[] organizationIds) Removes the organizations from the group.
static void	unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) Removes the organizations from the password policy.
static com.liferay.portal.kernel.model.OrganizationSoap	updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean hasLogo, byte[] logoBytes, boolean site, com.liferay.portal.kernel.model.AddressSoap[] addresses, com.liferay.portal.kernel.model.EmailAddressSoap[] emailAddresses, com.liferay.portal.kernel.model.OrgLaborSoap[] orgLabors, com.liferay.portal.kernel.model.PhoneSoap[] phones, com.liferay.portal.kernel.model.WebsiteSoap[] websites, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the organization with additional parameters.
static com.liferay.portal.kernel.model.OrganizationSoap	updateOrganization(long organizationId, long parentOrganizationId, java.lang.String name, java.lang.String type, long regionId, long countryId, long statusId, java.lang.String comments, boolean site, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the organization.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationServiceSoap

public OrganizationServiceSoap()

Method Detail

addGroupOrganizations

public static void addGroupOrganizations(long groupId,
                                         long[] organizationIds)
                                  throws java.rmi.RemoteException

Adds the organizations to the group.

Parameters:

groupId - the primary key of the group

organizationIds - the primary keys of the organizations

Throws:

java.rmi.RemoteException

addOrganization

public static com.liferay.portal.kernel.model.OrganizationSoap addOrganization(long parentOrganizationId,
                                                                               java.lang.String name,
                                                                               java.lang.String type,
                                                                               long regionId,
                                                                               long countryId,
                                                                               long statusId,
                                                                               java.lang.String comments,
                                                                               boolean site,
                                                                               com.liferay.portal.kernel.model.AddressSoap[] addresses,
                                                                               com.liferay.portal.kernel.model.EmailAddressSoap[] emailAddresses,
                                                                               com.liferay.portal.kernel.model.OrgLaborSoap[] orgLabors,
                                                                               com.liferay.portal.kernel.model.PhoneSoap[] phones,
                                                                               com.liferay.portal.kernel.model.WebsiteSoap[] websites,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws java.rmi.RemoteException

Adds an organization with additional parameters.

This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.

Parameters:

parentOrganizationId - the primary key of the organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

site - whether the organization is to be associated with a main site

addresses - the organization's addresses

emailAddresses - the organization's email addresses

orgLabors - the organization's hours of operation

phones - the organization's phone numbers

websites - the organization's websites

serviceContext - the service context to be applied (optionally null). Can set asset category IDs, asset tag names, and expando bridge attributes for the organization.

Returns:

the organization

Throws:

java.rmi.RemoteException

addOrganization

public static com.liferay.portal.kernel.model.OrganizationSoap addOrganization(long parentOrganizationId,
                                                                               java.lang.String name,
                                                                               java.lang.String type,
                                                                               long regionId,
                                                                               long countryId,
                                                                               long statusId,
                                                                               java.lang.String comments,
                                                                               boolean site,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws java.rmi.RemoteException

Adds an organization.

This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.

Parameters:

parentOrganizationId - the primary key of the organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

site - whether the organization is to be associated with a main site

serviceContext - the service context to be applied (optionally null). Can set asset category IDs, asset tag names, and expando bridge attributes for the organization.

Returns:

the organization

Throws:

java.rmi.RemoteException

addPasswordPolicyOrganizations

public static void addPasswordPolicyOrganizations(long passwordPolicyId,
                                                  long[] organizationIds)
                                           throws java.rmi.RemoteException

Assigns the password policy to the organizations, removing any other currently assigned password policies.

Parameters:

passwordPolicyId - the primary key of the password policy

organizationIds - the primary keys of the organizations

Throws:

java.rmi.RemoteException

deleteLogo

public static void deleteLogo(long organizationId)
                       throws java.rmi.RemoteException

Deletes the organization's logo.

Parameters:

organizationId - the primary key of the organization

Throws:

java.rmi.RemoteException

deleteOrganization

public static void deleteOrganization(long organizationId)
                               throws java.rmi.RemoteException

Deletes the organization. The organization's associated resources and assets are also deleted.

Parameters:

organizationId - the primary key of the organization

Throws:

java.rmi.RemoteException

fetchOrganization

public static com.liferay.portal.kernel.model.OrganizationSoap fetchOrganization(long organizationId)
                                                                          throws java.rmi.RemoteException

Returns the organization with the primary key.

Parameters:

organizationId - the primary key of the organization

Returns:

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

Throws:

java.rmi.RemoteException

getGtOrganizations

public static com.liferay.portal.kernel.model.OrganizationSoap[] getGtOrganizations(long gtOrganizationId,
                                                                                    long companyId,
                                                                                    long parentOrganizationId,
                                                                                    int size)
                                                                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getOrganization

public static com.liferay.portal.kernel.model.OrganizationSoap getOrganization(long organizationId)
                                                                        throws java.rmi.RemoteException

Returns the organization with the primary key.

Parameters:

organizationId - the primary key of the organization

Returns:

the organization with the primary key

Throws:

java.rmi.RemoteException

getOrganizationId

public static long getOrganizationId(long companyId,
                                     java.lang.String name)
                              throws java.rmi.RemoteException

Returns the primary key of the organization with the name.

Parameters:

companyId - the primary key of the organization's company

name - the organization's name

Returns:

the primary key of the organization with the name, or 0 if the organization could not be found

Throws:

java.rmi.RemoteException

getOrganizations

public static com.liferay.portal.kernel.model.OrganizationSoap[] getOrganizations(long companyId,
                                                                                  long parentOrganizationId)
                                                                           throws java.rmi.RemoteException

Returns all the organizations belonging to the parent organization.

Parameters:

companyId - the primary key of the organizations' company

parentOrganizationId - the primary key of the organizations' parent organization

Returns:

the organizations belonging to the parent organization

Throws:

java.rmi.RemoteException

getOrganizations

public static com.liferay.portal.kernel.model.OrganizationSoap[] getOrganizations(long companyId,
                                                                                  long parentOrganizationId,
                                                                                  int start,
                                                                                  int end)
                                                                           throws java.rmi.RemoteException

Returns a range of all the organizations belonging to the parent organization.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the organizations' company

parentOrganizationId - the primary key of the organizations' parent organization

start - the lower bound of the range of organizations to return

end - the upper bound of the range of organizations to return (not inclusive)

Returns:

the range of organizations belonging to the parent organization

Throws:

java.rmi.RemoteException

getOrganizations

public static com.liferay.portal.kernel.model.OrganizationSoap[] getOrganizations(long companyId,
                                                                                  long parentOrganizationId,
                                                                                  java.lang.String name,
                                                                                  int start,
                                                                                  int end)
                                                                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getOrganizationsCount

public static int getOrganizationsCount(long companyId,
                                        long parentOrganizationId)
                                 throws java.rmi.RemoteException

Returns the number of organizations belonging to the parent organization.

Parameters:

companyId - the primary key of the organizations' company

parentOrganizationId - the primary key of the organizations' parent organization

Returns:

the number of organizations belonging to the parent organization

Throws:

java.rmi.RemoteException

getOrganizationsCount

public static int getOrganizationsCount(long companyId,
                                        long parentOrganizationId,
                                        java.lang.String name)
                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getUserOrganizations

public static com.liferay.portal.kernel.model.OrganizationSoap[] getUserOrganizations(long userId)
                                                                               throws java.rmi.RemoteException

Returns all the organizations with which the user is explicitly associated.

A user is considered to be explicitly associated with an organization if his account is individually created within the organization or if the user is later added as a member.

Parameters:

userId - the primary key of the user

Returns:

the organizations with which the user is explicitly associated

Throws:

java.rmi.RemoteException

setGroupOrganizations

public static void setGroupOrganizations(long groupId,
                                         long[] organizationIds)
                                  throws java.rmi.RemoteException

Sets the organizations in the group, removing and adding organizations to the group as necessary.

Parameters:

groupId - the primary key of the group

organizationIds - the primary keys of the organizations

Throws:

java.rmi.RemoteException

unsetGroupOrganizations

public static void unsetGroupOrganizations(long groupId,
                                           long[] organizationIds)
                                    throws java.rmi.RemoteException

Removes the organizations from the group.

Parameters:

groupId - the primary key of the group

organizationIds - the primary keys of the organizations

Throws:

java.rmi.RemoteException

unsetPasswordPolicyOrganizations

public static void unsetPasswordPolicyOrganizations(long passwordPolicyId,
                                                    long[] organizationIds)
                                             throws java.rmi.RemoteException

Removes the organizations from the password policy.

Parameters:

passwordPolicyId - the primary key of the password policy

organizationIds - the primary keys of the organizations

Throws:

java.rmi.RemoteException

updateOrganization

public static com.liferay.portal.kernel.model.OrganizationSoap updateOrganization(long organizationId,
                                                                                  long parentOrganizationId,
                                                                                  java.lang.String name,
                                                                                  java.lang.String type,
                                                                                  long regionId,
                                                                                  long countryId,
                                                                                  long statusId,
                                                                                  java.lang.String comments,
                                                                                  boolean hasLogo,
                                                                                  byte[] logoBytes,
                                                                                  boolean site,
                                                                                  com.liferay.portal.kernel.model.AddressSoap[] addresses,
                                                                                  com.liferay.portal.kernel.model.EmailAddressSoap[] emailAddresses,
                                                                                  com.liferay.portal.kernel.model.OrgLaborSoap[] orgLabors,
                                                                                  com.liferay.portal.kernel.model.PhoneSoap[] phones,
                                                                                  com.liferay.portal.kernel.model.WebsiteSoap[] websites,
                                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                           throws java.rmi.RemoteException

Updates the organization with additional parameters.

Parameters:

organizationId - the primary key of the organization

parentOrganizationId - the primary key of the organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

hasLogo - if the organization has a custom logo

logoBytes - the new logo image data

site - whether the organization is to be associated with a main site

addresses - the organization's addresses

emailAddresses - the organization's email addresses

orgLabors - the organization's hours of operation

phones - the organization's phone numbers

websites - the organization's websites

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the organization, and merge expando bridge attributes for the organization.

Returns:

the organization

Throws:

java.rmi.RemoteException

updateOrganization

public static com.liferay.portal.kernel.model.OrganizationSoap updateOrganization(long organizationId,
                                                                                  long parentOrganizationId,
                                                                                  java.lang.String name,
                                                                                  java.lang.String type,
                                                                                  long regionId,
                                                                                  long countryId,
                                                                                  long statusId,
                                                                                  java.lang.String comments,
                                                                                  boolean site,
                                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                           throws java.rmi.RemoteException

Updates the organization.

Parameters:

organizationId - the primary key of the organization

parentOrganizationId - the primary key of the organization's parent organization

name - the organization's name

type - the organization's type

regionId - the primary key of the organization's region

countryId - the primary key of the organization's country

statusId - the organization's workflow status

comments - the comments about the organization

site - whether the organization is to be associated with a main site

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the organization, and merge expando bridge attributes for the organization.

Returns:

the organization

Throws:

java.rmi.RemoteException