com.liferay.portal.service.OrganizationServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the remote service utility for Organization. This utility wraps
* {@link com.liferay.portal.service.impl.OrganizationServiceImpl} and is the
* primary access point for service operations in application layer code running
* on a remote server. Methods of this service are expected to have security
* checks based on the propagated JAAS credentials because this service can be
* accessed remotely.
*
* @author Brian Wing Shun Chan
* @see OrganizationService
* @see com.liferay.portal.service.base.OrganizationServiceBaseImpl
* @see com.liferay.portal.service.impl.OrganizationServiceImpl
* @generated
*/
public class OrganizationServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.OrganizationServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
/**
* Adds the organizations to the group.
*
* @param groupId the primary key of the group
* @param organizationIds the primary keys of the organizations
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static void addGroupOrganizations(long groupId,
long[] organizationIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().addGroupOrganizations(groupId, organizationIds);
}
/**
* Adds an organization with additional parameters.
*
*
* This method handles the creation and bookkeeping of the organization
* including its resources, metadata, and internal data structures.
*
*
* @param parentOrganizationId the primary key of the organization's
parent organization
* @param name the organization's name
* @param type the organization's type
* @param recursable whether the permissions of the organization are to
be inherited by its suborganizations
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param addresses the organization's addresses
* @param emailAddresses the organization's email addresses
* @param orgLabors the organization's hours of operation
* @param phones the organization's phone numbers
* @param websites the organization's websites
* @param serviceContext the service context to be applied (optionally
null). Can set asset category IDs, asset tag
names, and expando bridge attributes for the organization.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #addOrganization(long,
String, String, long, long, int, String, boolean,
java.util.List, java.util.List, java.util.List,
java.util.List, java.util.List, ServiceContext)}
*/
public static com.liferay.portal.model.Organization addOrganization(
long parentOrganizationId, java.lang.String name,
java.lang.String type, boolean recursable, long regionId,
long countryId, int statusId, java.lang.String comments, boolean site,
java.util.List addresses,
java.util.List emailAddresses,
java.util.List orgLabors,
java.util.List phones,
java.util.List websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addOrganization(parentOrganizationId, name, type,
recursable, regionId, countryId, statusId, comments, site,
addresses, emailAddresses, orgLabors, phones, websites,
serviceContext);
}
/**
* Adds an organization.
*
*
* This method handles the creation and bookkeeping of the organization
* including its resources, metadata, and internal data structures.
*
*
* @param parentOrganizationId the primary key of the organization's
parent organization
* @param name the organization's name
* @param type the organization's type
* @param recursable whether the permissions of the organization are to
be inherited by its suborganizations
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param serviceContext the service context to be applied (optionally
null). Can set asset category IDs, asset tag
names, and expando bridge attributes for the organization.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #addOrganization(long,
String, String, long, long, int, String, boolean,
ServiceContext)}
*/
public static com.liferay.portal.model.Organization addOrganization(
long parentOrganizationId, java.lang.String name,
java.lang.String type, boolean recursable, long regionId,
long countryId, int statusId, java.lang.String comments, boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addOrganization(parentOrganizationId, name, type,
recursable, regionId, countryId, statusId, comments, site,
serviceContext);
}
/**
* Adds an organization with additional parameters.
*
*
* This method handles the creation and bookkeeping of the organization
* including its resources, metadata, and internal data structures.
*
*
* @param parentOrganizationId the primary key of the organization's parent
organization
* @param name the organization's name
* @param type the organization's type
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param addresses the organization's addresses
* @param emailAddresses the organization's email addresses
* @param orgLabors the organization's hours of operation
* @param phones the organization's phone numbers
* @param websites the organization's websites
* @param serviceContext the service context to be applied (optionally
null). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Organization addOrganization(
long parentOrganizationId, java.lang.String name,
java.lang.String type, long regionId, long countryId, int statusId,
java.lang.String comments, boolean site,
java.util.List addresses,
java.util.List emailAddresses,
java.util.List orgLabors,
java.util.List phones,
java.util.List websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addOrganization(parentOrganizationId, name, type, regionId,
countryId, statusId, comments, site, addresses, emailAddresses,
orgLabors, phones, websites, serviceContext);
}
/**
* Adds an organization.
*
*
* This method handles the creation and bookkeeping of the organization
* including its resources, metadata, and internal data structures.
*
*
* @param parentOrganizationId the primary key of the organization's parent
organization
* @param name the organization's name
* @param type the organization's type
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param serviceContext the service context to be applied (optionally
null). Can set asset category IDs, asset tag names,
and expando bridge attributes for the organization.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Organization addOrganization(
long parentOrganizationId, java.lang.String name,
java.lang.String type, long regionId, long countryId, int statusId,
java.lang.String comments, boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addOrganization(parentOrganizationId, name, type, regionId,
countryId, statusId, comments, site, serviceContext);
}
/**
* Assigns the password policy to the organizations, removing any other
* currently assigned password policies.
*
* @param passwordPolicyId the primary key of the password policy
* @param organizationIds the primary keys of the organizations
* @throws PortalException if the user did not have permission to update the
password policy
* @throws SystemException if a system exception occurred
*/
public static void addPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService()
.addPasswordPolicyOrganizations(passwordPolicyId, organizationIds);
}
/**
* Deletes the logo of the organization.
*
* @param organizationId the primary key of the organization
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static void deleteLogo(long organizationId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteLogo(organizationId);
}
/**
* Deletes the organization. The organization's associated resources and
* assets are also deleted.
*
* @param organizationId the primary key of the organization
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static void deleteOrganization(long organizationId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteOrganization(organizationId);
}
/**
* Returns all the organizations which the user has permission to manage.
*
* @param actionId the permitted action
* @param max the maximum number of the organizations to be considered
* @return the organizations which the user has permission to manage
* @throws PortalException if a portal exception occurred
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #getOrganizations(long, long,
int, int)}
*/
public static java.util.List getManageableOrganizations(
java.lang.String actionId, int max)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getManageableOrganizations(actionId, max);
}
/**
* Returns the organization with the primary key.
*
* @param organizationId the primary key of the organization
* @return the organization with the primary key
* @throws PortalException if an organization with the primary key could not
be found or if the user did not have permission to view the
organization
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Organization getOrganization(
long organizationId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getOrganization(organizationId);
}
/**
* Returns the primary key of the organization with the name.
*
* @param companyId the primary key of the organization's company
* @param name the organization's name
* @return the primary key of the organization with the name, or
0 if the organization could not be found
* @throws PortalException if the user did not have permission to view the
organization
* @throws SystemException if a system exception occurred
*/
public static long getOrganizationId(long companyId, java.lang.String name)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getOrganizationId(companyId, name);
}
/**
* Returns all the organizations belonging to the parent organization.
*
* @param companyId the primary key of the organizations' company
* @param parentOrganizationId the primary key of the organizations' parent
organization
* @return the organizations belonging to the parent organization
* @throws SystemException if a system exception occurred
*/
public static java.util.List getOrganizations(
long companyId, long parentOrganizationId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getOrganizations(companyId, parentOrganizationId);
}
/**
* 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 {@link
* com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param companyId the primary key of the organizations' company
* @param parentOrganizationId the primary key of the organizations' parent
organization
* @param start the lower bound of the range of organizations to return
* @param end the upper bound of the range of organizations to return (not
inclusive)
* @return the range of organizations belonging to the parent organization
* @throws SystemException if a system exception occurred
*/
public static java.util.List getOrganizations(
long companyId, long parentOrganizationId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getOrganizations(companyId, parentOrganizationId, start, end);
}
/**
* Returns the number of organizations belonging to the parent organization.
*
* @param companyId the primary key of the organizations' company
* @param parentOrganizationId the primary key of the organizations' parent
organization
* @return the number of organizations belonging to the parent organization
* @throws SystemException if a system exception occurred
*/
public static int getOrganizationsCount(long companyId,
long parentOrganizationId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getOrganizationsCount(companyId, parentOrganizationId);
}
/**
* Returns all the organizations associated with the user.
*
* @param userId the primary key of the user
* @return the organizations associated with the user
* @throws PortalException if a user with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static java.util.List getUserOrganizations(
long userId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getUserOrganizations(userId);
}
/**
* Sets the organizations in the group, removing and adding organizations to
* the group as necessary.
*
* @param groupId the primary key of the group
* @param organizationIds the primary keys of the organizations
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static void setGroupOrganizations(long groupId,
long[] organizationIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().setGroupOrganizations(groupId, organizationIds);
}
/**
* Removes the organizations from the group.
*
* @param groupId the primary key of the group
* @param organizationIds the primary keys of the organizations
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static void unsetGroupOrganizations(long groupId,
long[] organizationIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().unsetGroupOrganizations(groupId, organizationIds);
}
/**
* Removes the organizations from the password policy.
*
* @param passwordPolicyId the primary key of the password policy
* @param organizationIds the primary keys of the organizations
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static void unsetPasswordPolicyOrganizations(long passwordPolicyId,
long[] organizationIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService()
.unsetPasswordPolicyOrganizations(passwordPolicyId, organizationIds);
}
/**
* Updates the organization with additional parameters.
*
* @param organizationId the primary key of the organization
* @param parentOrganizationId the primary key of the organization's
parent organization
* @param name the organization's name
* @param type the organization's type
* @param recursable whether the permissions of the organization are to
be inherited by its suborganizations
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param addresses the organization's addresses
* @param emailAddresses the organization's email addresses
* @param orgLabors the organization's hours of operation
* @param phones the organization's phone numbers
* @param websites the organization's websites
* @param 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.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #updateOrganization(long,
long, String, String, long, long, int, String, boolean,
java.util.List, java.util.List, java.util.List,
java.util.List, java.util.List, ServiceContext)}
*/
public static com.liferay.portal.model.Organization updateOrganization(
long organizationId, long parentOrganizationId, java.lang.String name,
java.lang.String type, boolean recursable, long regionId,
long countryId, int statusId, java.lang.String comments, boolean site,
java.util.List addresses,
java.util.List emailAddresses,
java.util.List orgLabors,
java.util.List phones,
java.util.List websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateOrganization(organizationId, parentOrganizationId,
name, type, recursable, regionId, countryId, statusId, comments,
site, addresses, emailAddresses, orgLabors, phones, websites,
serviceContext);
}
/**
* Updates the organization.
*
* @param organizationId the primary key of the organization
* @param parentOrganizationId the primary key of the organization's
parent organization
* @param name the organization's name
* @param type the organization's type
* @param recursable whether permissions of the organization are to be
inherited by its suborganizations
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param 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.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
* @deprecated As of 6.2.0, replaced by {@link #updateOrganization(long,
long, String, String, long, long, int, String, boolean,
ServiceContext)}
*/
public static com.liferay.portal.model.Organization updateOrganization(
long organizationId, long parentOrganizationId, java.lang.String name,
java.lang.String type, boolean recursable, long regionId,
long countryId, int statusId, java.lang.String comments, boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateOrganization(organizationId, parentOrganizationId,
name, type, recursable, regionId, countryId, statusId, comments,
site, serviceContext);
}
/**
* Updates the organization with additional parameters.
*
* @param organizationId the primary key of the organization
* @param parentOrganizationId the primary key of the organization's parent
organization
* @param name the organization's name
* @param type the organization's type
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param addresses the organization's addresses
* @param emailAddresses the organization's email addresses
* @param orgLabors the organization's hours of operation
* @param phones the organization's phone numbers
* @param websites the organization's websites
* @param 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.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Organization updateOrganization(
long organizationId, long parentOrganizationId, java.lang.String name,
java.lang.String type, long regionId, long countryId, int statusId,
java.lang.String comments, boolean site,
java.util.List addresses,
java.util.List emailAddresses,
java.util.List orgLabors,
java.util.List phones,
java.util.List websites,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateOrganization(organizationId, parentOrganizationId,
name, type, regionId, countryId, statusId, comments, site,
addresses, emailAddresses, orgLabors, phones, websites,
serviceContext);
}
/**
* Updates the organization.
*
* @param organizationId the primary key of the organization
* @param parentOrganizationId the primary key of the organization's parent
organization
* @param name the organization's name
* @param type the organization's type
* @param regionId the primary key of the organization's region
* @param countryId the primary key of the organization's country
* @param statusId the organization's workflow status
* @param comments the comments about the organization
* @param site whether the organization is to be associated with a main
site
* @param 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.
* @return the organization
* @throws 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.Organization updateOrganization(
long organizationId, long parentOrganizationId, java.lang.String name,
java.lang.String type, long regionId, long countryId, int statusId,
java.lang.String comments, boolean site,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateOrganization(organizationId, parentOrganizationId,
name, type, regionId, countryId, statusId, comments, site,
serviceContext);
}
public static OrganizationService getService() {
if (_service == null) {
_service = (OrganizationService)PortalBeanLocatorUtil.locate(OrganizationService.class.getName());
ReferenceRegistry.registerReference(OrganizationServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(OrganizationService service) {
}
private static OrganizationService _service;
}