Java tutorial
/** * Copyright (c) 2000-present 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.kernel.service; import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; /** * Provides the remote service utility for Organization. This utility wraps * <code>com.liferay.portal.service.impl.OrganizationServiceImpl</code> and is an * 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 * @generated */ public class OrganizationServiceUtil { /** * NOTE FOR DEVELOPERS: * * Never modify this class directly. Add custom service methods to <code>com.liferay.portal.service.impl.OrganizationServiceImpl</code> and rerun ServiceBuilder to regenerate this class. */ /** * Adds the organizations to the group. * * @param groupId the primary key of the group * @param organizationIds the primary keys of the organizations */ public static void addGroupOrganizations(long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException { getService().addGroupOrganizations(groupId, organizationIds); } /** * Adds an organization with additional parameters. * * <p> * This method handles the creation and bookkeeping of the organization * including its resources, metadata, and internal data structures. * </p> * * @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 <code>null</code>). Can set asset category IDs, asset tag names, and expando bridge attributes for the organization. * @return the organization */ public static com.liferay.portal.kernel.model.Organization addOrganization(long parentOrganizationId, String name, String type, long regionId, long countryId, long statusId, String comments, boolean site, java.util.List<com.liferay.portal.kernel.model.Address> addresses, java.util.List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, java.util.List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, java.util.List<com.liferay.portal.kernel.model.Phone> phones, java.util.List<com.liferay.portal.kernel.model.Website> websites, ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException { return getService().addOrganization(parentOrganizationId, name, type, regionId, countryId, statusId, comments, site, addresses, emailAddresses, orgLabors, phones, websites, serviceContext); } /** * Adds an organization. * * <p> * This method handles the creation and bookkeeping of the organization * including its resources, metadata, and internal data structures. * </p> * * @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 <code>null</code>). Can set asset category IDs, asset tag names, and expando bridge attributes for the organization. * @return the organization */ public static com.liferay.portal.kernel.model.Organization addOrganization(long parentOrganizationId, String name, String type, long regionId, long countryId, long statusId, String comments, boolean site, ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException { 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 */ public static void addPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException { getService().addPasswordPolicyOrganizations(passwordPolicyId, organizationIds); } /** * Deletes the organization's logo. * * @param organizationId the primary key of the organization */ public static void deleteLogo(long organizationId) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteLogo(organizationId); } /** * Deletes the organization. The organization's associated resources and * assets are also deleted. * * @param organizationId the primary key of the organization */ public static void deleteOrganization(long organizationId) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteOrganization(organizationId); } /** * Returns the organization with the primary key. * * @param organizationId the primary key of the organization * @return the organization with the primary key, or <code>null</code> if an organization with the primary key could not be found or if the user did not have permission to view the organization */ public static com.liferay.portal.kernel.model.Organization fetchOrganization(long organizationId) throws com.liferay.portal.kernel.exception.PortalException { return getService().fetchOrganization(organizationId); } public static java.util.List<com.liferay.portal.kernel.model.Organization> getGtOrganizations( long gtOrganizationId, long companyId, long parentOrganizationId, int size) { return getService().getGtOrganizations(gtOrganizationId, companyId, parentOrganizationId, size); } /** * Returns the organization with the primary key. * * @param organizationId the primary key of the organization * @return the organization with the primary key */ public static com.liferay.portal.kernel.model.Organization getOrganization(long organizationId) throws com.liferay.portal.kernel.exception.PortalException { 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 <code>0</code> if the organization could not be found */ public static long getOrganizationId(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException { 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 */ public static java.util.List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId) { return getService().getOrganizations(companyId, parentOrganizationId); } /** * Returns a range of all the organizations belonging to the parent * organization. * * <p> * Useful when paginating results. Returns a maximum of <code>end - * start</code> instances. <code>start</code> and <code>end</code> are not * primary keys, they are indexes in the result set. Thus, <code>0</code> * refers to the first result in the set. Setting both <code>start</code> * and <code>end</code> to {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. * </p> * * @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 */ public static java.util.List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId, int start, int end) { return getService().getOrganizations(companyId, parentOrganizationId, start, end); } public static java.util.List<com.liferay.portal.kernel.model.Organization> getOrganizations(long companyId, long parentOrganizationId, String name, int start, int end) { return getService().getOrganizations(companyId, parentOrganizationId, name, 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 */ public static int getOrganizationsCount(long companyId, long parentOrganizationId) { return getService().getOrganizationsCount(companyId, parentOrganizationId); } public static int getOrganizationsCount(long companyId, long parentOrganizationId, String name) throws com.liferay.portal.kernel.exception.PortalException { return getService().getOrganizationsCount(companyId, parentOrganizationId, name); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ public static String getOSGiServiceIdentifier() { return getService().getOSGiServiceIdentifier(); } /** * Returns all the organizations with which the user is explicitly * associated. * * <p> * A user is considered to be <i>explicitly</i> associated with an * organization if his account is individually created within the * organization or if the user is later added as a member. * </p> * * @param userId the primary key of the user * @return the organizations with which the user is explicitly associated */ public static java.util.List<com.liferay.portal.kernel.model.Organization> getUserOrganizations(long userId) throws com.liferay.portal.kernel.exception.PortalException { 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 */ public static void setGroupOrganizations(long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException { 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 */ public static void unsetGroupOrganizations(long groupId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException { 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 */ public static void unsetPasswordPolicyOrganizations(long passwordPolicyId, long[] organizationIds) throws com.liferay.portal.kernel.exception.PortalException { 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 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 hasLogo if the organization has a custom logo * @param logoBytes the new logo image data * @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 <code>null</code>). Can set asset category IDs and asset tag names for the organization, and merge expando bridge attributes for the organization. * @return the organization */ public static com.liferay.portal.kernel.model.Organization updateOrganization(long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusId, String comments, boolean hasLogo, byte[] logoBytes, boolean site, java.util.List<com.liferay.portal.kernel.model.Address> addresses, java.util.List<com.liferay.portal.kernel.model.EmailAddress> emailAddresses, java.util.List<com.liferay.portal.kernel.model.OrgLabor> orgLabors, java.util.List<com.liferay.portal.kernel.model.Phone> phones, java.util.List<com.liferay.portal.kernel.model.Website> websites, ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException { return getService().updateOrganization(organizationId, parentOrganizationId, name, type, regionId, countryId, statusId, comments, hasLogo, logoBytes, 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 <code>null</code>). Can set asset category IDs and asset tag names for the organization, and merge expando bridge attributes for the organization. * @return the organization */ public static com.liferay.portal.kernel.model.Organization updateOrganization(long organizationId, long parentOrganizationId, String name, String type, long regionId, long countryId, long statusId, String comments, boolean site, ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException { 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()); } return _service; } private static OrganizationService _service; }