@ProviderType
public class OrganizationServiceSoap
extends java.lang.Object
OrganizationServiceUtil 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 OrganizationSoap.
If the method in the service utility returns a
Organization, that is translated to a
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.
OrganizationServiceHttp,
OrganizationSoap,
OrganizationServiceUtil| Constructor and Description |
|---|
OrganizationServiceSoap() |
| Modifier and Type | Method and Description |
|---|---|
static void |
addGroupOrganizations(long groupId,
long[] organizationIds)
Adds the organizations to the group.
|
static com.liferay.portal.model.OrganizationSoap |
addOrganization(long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
#addOrganization(long,
String, String, long, long, int, String, boolean, List, List,
List, List, List, ServiceContext) |
static com.liferay.portal.model.OrganizationSoap |
addOrganization(long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
#addOrganization(long,
String, String, long, long, int, String, boolean,
ServiceContext) |
static com.liferay.portal.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.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
Adds an organization with additional parameters.
|
static com.liferay.portal.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.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.model.OrganizationSoap |
fetchOrganization(long organizationId)
Returns the organization with the primary key.
|
static com.liferay.portal.model.OrganizationSoap[] |
getManageableOrganizations(java.lang.String actionId,
int max)
Deprecated.
As of 6.2.0, replaced by
getOrganizations(long, long,
int, int) |
static com.liferay.portal.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.model.OrganizationSoap[] |
getOrganizations(long companyId,
long parentOrganizationId)
Returns all the organizations belonging to the parent organization.
|
static com.liferay.portal.model.OrganizationSoap[] |
getOrganizations(long companyId,
long parentOrganizationId,
int start,
int end)
Returns a range of all the organizations belonging to the parent
organization.
|
static int |
getOrganizationsCount(long companyId,
long parentOrganizationId)
Returns the number of organizations belonging to the parent organization.
|
static com.liferay.portal.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.model.OrganizationSoap |
updateOrganization(long organizationId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext) |
static com.liferay.portal.model.OrganizationSoap |
updateOrganization(long organizationId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
ServiceContext) |
static com.liferay.portal.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.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
Deprecated.
As of 7.0.0, replaced by
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext) |
static com.liferay.portal.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 logo,
byte[] logoBytes,
boolean site,
com.liferay.portal.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
Updates the organization with additional parameters.
|
static com.liferay.portal.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.service.ServiceContext serviceContext)
Updates the organization.
|
public static void addGroupOrganizations(long groupId,
long[] organizationIds)
throws java.rmi.RemoteException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizationsjava.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.OrganizationSoap addOrganization(long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
#addOrganization(long,
String, String, long, long, int, String, boolean, List, List,
List, List, List, ServiceContext)This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
parentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether the permissions of the organization are to
be inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteaddresses - the organization's addressesemailAddresses - the organization's email addressesorgLabors - the organization's hours of operationphones - the organization's phone numberswebsites - the organization's websitesserviceContext - the service context to be applied (optionally
null). Can set asset category IDs, asset tag
names, and expando bridge attributes for the organization.java.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.OrganizationSoap addOrganization(long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
#addOrganization(long,
String, String, long, long, int, String, boolean,
ServiceContext)This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
parentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether the permissions of the organization are to
be inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteserviceContext - the service context to be applied (optionally
null). Can set asset category IDs, asset tag
names, and expando bridge attributes for the organization.java.rmi.RemoteExceptionpublic static com.liferay.portal.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.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
parentOrganizationId - the primary key of the organization's parent
organizationname - the organization's nametype - the organization's typeregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteaddresses - the organization's addressesemailAddresses - the organization's email addressesorgLabors - the organization's hours of operationphones - the organization's phone numberswebsites - the organization's websitesserviceContext - the service context to be applied (optionally
null). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.java.rmi.RemoteExceptionpublic static com.liferay.portal.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.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
This method handles the creation and bookkeeping of the organization including its resources, metadata, and internal data structures.
parentOrganizationId - the primary key of the organization's parent
organizationname - the organization's nametype - the organization's typeregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteserviceContext - the service context to be applied (optionally
null). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.java.rmi.RemoteExceptionpublic static void addPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws java.rmi.RemoteException
passwordPolicyId - the primary key of the password policyorganizationIds - the primary keys of the organizationsjava.rmi.RemoteExceptionpublic static void deleteLogo(long organizationId)
throws java.rmi.RemoteException
organizationId - the primary key of the organizationjava.rmi.RemoteExceptionpublic static void deleteOrganization(long organizationId)
throws java.rmi.RemoteException
organizationId - the primary key of the organizationjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.OrganizationSoap fetchOrganization(long organizationId)
throws java.rmi.RemoteException
organizationId - the primary key of the organizationnull if an
organization with the primary key could not be found or if the
user did not have permission to view the organizationjava.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.OrganizationSoap[] getManageableOrganizations(java.lang.String actionId,
int max)
throws java.rmi.RemoteException
getOrganizations(long, long,
int, int)actionId - the permitted actionmax - the maximum number of the organizations to be consideredjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.OrganizationSoap getOrganization(long organizationId)
throws java.rmi.RemoteException
organizationId - the primary key of the organizationjava.rmi.RemoteExceptionpublic static long getOrganizationId(long companyId,
java.lang.String name)
throws java.rmi.RemoteException
companyId - the primary key of the organization's companyname - the organization's name0 if the organization could not be foundjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.OrganizationSoap[] getOrganizations(long companyId,
long parentOrganizationId)
throws java.rmi.RemoteException
companyId - the primary key of the organizations' companyparentOrganizationId - the primary key of the organizations' parent
organizationjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.OrganizationSoap[] getOrganizations(long companyId,
long parentOrganizationId,
int start,
int end)
throws java.rmi.RemoteException
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.
companyId - the primary key of the organizations' companyparentOrganizationId - the primary key of the organizations' parent
organizationstart - the lower bound of the range of organizations to returnend - the upper bound of the range of organizations to return (not
inclusive)java.rmi.RemoteExceptionpublic static int getOrganizationsCount(long companyId,
long parentOrganizationId)
throws java.rmi.RemoteException
companyId - the primary key of the organizations' companyparentOrganizationId - the primary key of the organizations' parent
organizationjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.OrganizationSoap[] getUserOrganizations(long userId)
throws java.rmi.RemoteException
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.
userId - the primary key of the userjava.rmi.RemoteExceptionpublic static void setGroupOrganizations(long groupId,
long[] organizationIds)
throws java.rmi.RemoteException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizationsjava.rmi.RemoteExceptionpublic static void unsetGroupOrganizations(long groupId,
long[] organizationIds)
throws java.rmi.RemoteException
groupId - the primary key of the grouporganizationIds - the primary keys of the organizationsjava.rmi.RemoteExceptionpublic static void unsetPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws java.rmi.RemoteException
passwordPolicyId - the primary key of the password policyorganizationIds - the primary keys of the organizationsjava.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.OrganizationSoap updateOrganization(long organizationId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext)organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether the permissions of the organization are to
be inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteaddresses - the organization's addressesemailAddresses - the organization's email addressesorgLabors - the organization's hours of operationphones - the organization's phone numberswebsites - the organization's websitesserviceContext - 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.java.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.OrganizationSoap updateOrganization(long organizationId,
long parentOrganizationId,
java.lang.String name,
java.lang.String type,
boolean recursable,
long regionId,
long countryId,
long statusId,
java.lang.String comments,
boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
ServiceContext)organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typerecursable - whether permissions of the organization are to be
inherited by its suborganizationsregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteserviceContext - 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.java.rmi.RemoteExceptionpublic static com.liferay.portal.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 logo,
byte[] logoBytes,
boolean site,
com.liferay.portal.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's parent
organizationname - the organization's nametype - the organization's typeregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationlogo - whether to update the ogranization's logologoBytes - the new logo image datasite - whether the organization is to be associated with a main
siteaddresses - the organization's addressesemailAddresses - the organization's email addressesorgLabors - the organization's hours of operationphones - the organization's phone numberswebsites - the organization's websitesserviceContext - 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.java.rmi.RemoteException@Deprecated
public static com.liferay.portal.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.model.AddressSoap[] addresses,
com.liferay.portal.model.EmailAddressSoap[] emailAddresses,
com.liferay.portal.model.OrgLaborSoap[] orgLabors,
com.liferay.portal.model.PhoneSoap[] phones,
com.liferay.portal.model.WebsiteSoap[] websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
#updateOrganization(long,
long, String, String, long, long, int, String, boolean,
byte[], boolean, List, List, List, List, List,
ServiceContext)organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's
parent organizationname - the organization's nametype - the organization's typeregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteaddresses - the organization's addressesemailAddresses - the organization's email addressesorgLabors - the organization's hours of operationphones - the organization's phone numberswebsites - the organization's websitesserviceContext - 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.java.rmi.RemoteExceptionpublic static com.liferay.portal.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.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
organizationId - the primary key of the organizationparentOrganizationId - the primary key of the organization's parent
organizationname - the organization's nametype - the organization's typeregionId - the primary key of the organization's regioncountryId - the primary key of the organization's countrystatusId - the organization's workflow statuscomments - the comments about the organizationsite - whether the organization is to be associated with a main
siteserviceContext - 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.java.rmi.RemoteException