|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.http.OrganizationServiceSoap
public class OrganizationServiceSoap
This class provides a SOAP utility for the
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/secure/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 Summary | |
---|---|
OrganizationServiceSoap()
|
Method Summary | |
---|---|
static void |
addGroupOrganizations(long groupId,
long[] organizationIds)
Adds the organizations to the group. |
static OrganizationSoap |
addOrganization(long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
int statusId,
String comments,
boolean site,
AddressSoap[] addresses,
EmailAddressSoap[] emailAddresses,
OrgLaborSoap[] orgLabors,
PhoneSoap[] phones,
WebsiteSoap[] websites,
ServiceContext serviceContext)
Adds an organization with additional parameters. |
static OrganizationSoap |
addOrganization(long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
int statusId,
String comments,
boolean site,
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 logo of the organization. |
static void |
deleteOrganization(long organizationId)
Deletes the organization. |
static OrganizationSoap[] |
getManageableOrganizations(String actionId,
int max)
Deprecated. Replaced by getOrganizations(long, long, int, int) |
static OrganizationSoap |
getOrganization(long organizationId)
Returns the organization with the primary key. |
static long |
getOrganizationId(long companyId,
String name)
Returns the primary key of the organization with the name. |
static OrganizationSoap[] |
getOrganizations(long companyId,
long parentOrganizationId)
Returns all the organizations belonging to the parent organization. |
static 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 OrganizationSoap[] |
getUserOrganizations(long userId)
Returns all the organizations associated with the user. |
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 OrganizationSoap |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
int statusId,
String comments,
boolean site,
AddressSoap[] addresses,
EmailAddressSoap[] emailAddresses,
OrgLaborSoap[] orgLabors,
PhoneSoap[] phones,
WebsiteSoap[] websites,
ServiceContext serviceContext)
Updates the organization with additional parameters. |
static OrganizationSoap |
updateOrganization(long organizationId,
long parentOrganizationId,
String name,
String type,
boolean recursable,
long regionId,
long countryId,
int statusId,
String comments,
boolean site,
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 |
---|
public OrganizationServiceSoap()
Method Detail |
---|
public static void addGroupOrganizations(long groupId, long[] organizationIds) throws RemoteException
groupId
- the primary key of the grouporganizationIds
- the primary keys of the organizations
PortalException
- if a group or organization with the primary key
could not be found or if the user did not have permission to
assign group members
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap addOrganization(long parentOrganizationId, String name, String type, boolean recursable, long regionId, long countryId, int statusId, String comments, boolean site, AddressSoap[] addresses, EmailAddressSoap[] emailAddresses, OrgLaborSoap[] orgLabors, PhoneSoap[] phones, WebsiteSoap[] websites, ServiceContext serviceContext) throws 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 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 organization's service context (optionally
null
). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.
PortalException
- if a parent organization with the primary key
could not be found, if the organization's information was
invalid, or if the user did not have permission to add the
organization
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap addOrganization(long parentOrganizationId, String name, String type, boolean recursable, long regionId, long countryId, int statusId, String comments, boolean site, ServiceContext serviceContext) throws 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 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 organization's service context (optionally
null
). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.
PortalException
- if the parent organization with the primary key
could not be found, if the organization information was invalid,
or if the user did not have permission to add the organization
SystemException
- if a system exception occurred
RemoteException
public static void addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) throws RemoteException
passwordPolicyId
- the primary key of the password policyorganizationIds
- the primary keys of the organizations
PortalException
- if the user did not have permission to update the
password policy
SystemException
- if a system exception occurred
RemoteException
public static void deleteLogo(long organizationId) throws RemoteException
organizationId
- the primary key of the organization
PortalException
- if an organization with the primary key could not
be found, if the organization's logo could not be found, or if
the user did not have permission to update the organization
SystemException
- if a system exception occurred
RemoteException
public static void deleteOrganization(long organizationId) throws RemoteException
organizationId
- the primary key of the organization
PortalException
- if an organization with the primary key could not
be found, if the user did not have permission to delete the
organization, if the organization had a workflow in approved
status, or if the organization was a parent organization
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap[] getManageableOrganizations(String actionId, int max) throws RemoteException
getOrganizations(long, long, int, int)
actionId
- the permitted actionmax
- the maximum number of the organizations to be considered
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap getOrganization(long organizationId) throws RemoteException
organizationId
- the primary key of the organization
PortalException
- if an organization with the primary key could not
be found or if the user did not have permission to view the
organization
SystemException
- if a system exception occurred
RemoteException
public static long getOrganizationId(long companyId, String name) throws RemoteException
companyId
- the primary key of the organization's companyname
- the organization's name
0
if the organization could not be found
PortalException
- if the user did not have permission to view the
organization
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap[] getOrganizations(long companyId, long parentOrganizationId) throws RemoteException
companyId
- the primary key of the organizations' companyparentOrganizationId
- the primary key of the organizations' parent
organization
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap[] getOrganizations(long companyId, long parentOrganizationId, int start, int end) throws 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)
SystemException
- if a system exception occurred
RemoteException
public static int getOrganizationsCount(long companyId, long parentOrganizationId) throws RemoteException
companyId
- the primary key of the organizations' companyparentOrganizationId
- the primary key of the organizations' parent
organization
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap[] getUserOrganizations(long userId) throws RemoteException
userId
- the primary key of the user
PortalException
- if a user with the primary key could not be found
SystemException
- if a system exception occurred
RemoteException
public static void setGroupOrganizations(long groupId, long[] organizationIds) throws RemoteException
groupId
- the primary key of the grouporganizationIds
- the primary keys of the organizations
PortalException
- if a group or organization with the primary key
could not be found or if the user did not have permission to
assign group members
SystemException
- if a system exception occurred
RemoteException
public static void unsetGroupOrganizations(long groupId, long[] organizationIds) throws RemoteException
groupId
- the primary key of the grouporganizationIds
- the primary keys of the organizations
PortalException
- if a group or organization with the primary key
could not be found or if the user did not have permission to
assign group members
SystemException
- if a system exception occurred
RemoteException
public static void unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) throws RemoteException
passwordPolicyId
- the primary key of the password policyorganizationIds
- the primary keys of the organizations
PortalException
- if a password policy or organization with the
primary key could not be found, or if the user did not have
permission to update the password policy
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap updateOrganization(long organizationId, long parentOrganizationId, String name, String type, boolean recursable, long regionId, long countryId, int statusId, String comments, boolean site, AddressSoap[] addresses, EmailAddressSoap[] emailAddresses, OrgLaborSoap[] orgLabors, PhoneSoap[] phones, WebsiteSoap[] websites, ServiceContext serviceContext) throws RemoteException
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 organization's service context (optionally
null
). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge attributes
for the organization.
PortalException
- if an organization or parent organization with
the primary key could not be found, if the user did not have
permission to update the organization information, or if the new
information was invalid
SystemException
- if a system exception occurred
RemoteException
public static OrganizationSoap updateOrganization(long organizationId, long parentOrganizationId, String name, String type, boolean recursable, long regionId, long countryId, int statusId, String comments, boolean site, ServiceContext serviceContext) throws RemoteException
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 organization's service context (optionally
null
). Can set asset category IDs and asset tag
names for the organization, and merge expando bridge attributes
for the organization.
PortalException
- if an organization or parent organization with
the primary key could not be found, if the user did not have
permission to update the organization, or if the new information
was invalid
SystemException
- if a system exception occurred
RemoteException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |