001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the organization local service. This utility wraps {@link com.liferay.portal.service.impl.OrganizationLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.OrganizationLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see OrganizationLocalService
032     * @see com.liferay.portal.service.base.OrganizationLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.OrganizationLocalServiceImpl
034     * @generated
035     */
036    public class OrganizationLocalServiceUtil {
037            /**
038            * Adds the organization to the database. Also notifies the appropriate model listeners.
039            *
040            * @param organization the organization to add
041            * @return the organization that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.Organization addOrganization(
045                    com.liferay.portal.model.Organization organization)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addOrganization(organization);
048            }
049    
050            /**
051            * Creates a new organization with the primary key. Does not add the organization to the database.
052            *
053            * @param organizationId the primary key for the new organization
054            * @return the new organization
055            */
056            public static com.liferay.portal.model.Organization createOrganization(
057                    long organizationId) {
058                    return getService().createOrganization(organizationId);
059            }
060    
061            /**
062            * Deletes the organization with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param organizationId the primary key of the organization to delete
065            * @throws PortalException if a organization with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteOrganization(long organizationId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteOrganization(organizationId);
072            }
073    
074            /**
075            * Deletes the organization from the database. Also notifies the appropriate model listeners.
076            *
077            * @param organization the organization to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteOrganization(
081                    com.liferay.portal.model.Organization organization)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteOrganization(organization);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the organization with the primary key.
159            *
160            * @param organizationId the primary key of the organization to get
161            * @return the organization
162            * @throws PortalException if a organization with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.Organization getOrganization(
166                    long organizationId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getOrganization(organizationId);
170            }
171    
172            /**
173            * Gets a range of all the organizations.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of organizations to return
180            * @param end the upper bound of the range of organizations to return (not inclusive)
181            * @return the range of organizations
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.Organization> getOrganizations(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getOrganizations(start, end);
188            }
189    
190            /**
191            * Gets the number of organizations.
192            *
193            * @return the number of organizations
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getOrganizationsCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getOrganizationsCount();
199            }
200    
201            /**
202            * Updates the organization in the database. Also notifies the appropriate model listeners.
203            *
204            * @param organization the organization to update
205            * @return the organization that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.Organization updateOrganization(
209                    com.liferay.portal.model.Organization organization)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateOrganization(organization);
212            }
213    
214            /**
215            * Updates the organization in the database. Also notifies the appropriate model listeners.
216            *
217            * @param organization the organization to update
218            * @param merge whether to merge the organization with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
219            * @return the organization that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.Organization updateOrganization(
223                    com.liferay.portal.model.Organization organization, boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().updateOrganization(organization, merge);
226            }
227    
228            public static void addGroupOrganizations(long groupId,
229                    long[] organizationIds)
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException {
232                    getService().addGroupOrganizations(groupId, organizationIds);
233            }
234    
235            public static com.liferay.portal.model.Organization addOrganization(
236                    long userId, long parentOrganizationId, java.lang.String name,
237                    java.lang.String type, boolean recursable, long regionId,
238                    long countryId, int statusId, java.lang.String comments,
239                    com.liferay.portal.service.ServiceContext serviceContext)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException {
242                    return getService()
243                                       .addOrganization(userId, parentOrganizationId, name, type,
244                            recursable, regionId, countryId, statusId, comments, serviceContext);
245            }
246    
247            public static void addOrganizationResources(long userId,
248                    com.liferay.portal.model.Organization organization)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException {
251                    getService().addOrganizationResources(userId, organization);
252            }
253    
254            public static void addPasswordPolicyOrganizations(long passwordPolicyId,
255                    long[] organizationIds)
256                    throws com.liferay.portal.kernel.exception.SystemException {
257                    getService()
258                            .addPasswordPolicyOrganizations(passwordPolicyId, organizationIds);
259            }
260    
261            public static void deleteLogo(long organizationId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    getService().deleteLogo(organizationId);
265            }
266    
267            public static java.util.List<com.liferay.portal.model.Organization> getGroupOrganizations(
268                    long groupId)
269                    throws com.liferay.portal.kernel.exception.SystemException {
270                    return getService().getGroupOrganizations(groupId);
271            }
272    
273            public static com.liferay.portal.model.Organization getOrganization(
274                    long companyId, java.lang.String name)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService().getOrganization(companyId, name);
278            }
279    
280            public static long getOrganizationId(long companyId, java.lang.String name)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    return getService().getOrganizationId(companyId, name);
283            }
284    
285            public static java.util.List<com.liferay.portal.model.Organization> getOrganizations(
286                    long[] organizationIds)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    return getService().getOrganizations(organizationIds);
290            }
291    
292            public static java.util.List<com.liferay.portal.model.Organization> getParentOrganizations(
293                    long organizationId)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    return getService().getParentOrganizations(organizationId);
297            }
298    
299            public static java.util.List<com.liferay.portal.model.Organization> getSuborganizations(
300                    java.util.List<com.liferay.portal.model.Organization> organizations)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    return getService().getSuborganizations(organizations);
303            }
304    
305            public static java.util.List<com.liferay.portal.model.Organization> getSubsetOrganizations(
306                    java.util.List<com.liferay.portal.model.Organization> allOrganizations,
307                    java.util.List<com.liferay.portal.model.Organization> availableOrganizations) {
308                    return getService()
309                                       .getSubsetOrganizations(allOrganizations,
310                            availableOrganizations);
311            }
312    
313            public static java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
314                    long userId)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getUserOrganizations(userId);
318            }
319    
320            public static java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
321                    long userId, boolean inheritUserGroups)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    return getService().getUserOrganizations(userId, inheritUserGroups);
325            }
326    
327            public static java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
328                    long userId, boolean inheritUserGroups, int start, int end)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException {
331                    return getService()
332                                       .getUserOrganizations(userId, inheritUserGroups, start, end);
333            }
334    
335            public static java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
336                    long userId, int start, int end)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getUserOrganizations(userId, start, end);
340            }
341    
342            public static int getUserOrganizationsCount(long userId)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().getUserOrganizationsCount(userId);
345            }
346    
347            public static boolean hasGroupOrganization(long groupId, long organizationId)
348                    throws com.liferay.portal.kernel.exception.SystemException {
349                    return getService().hasGroupOrganization(groupId, organizationId);
350            }
351    
352            public static boolean hasPasswordPolicyOrganization(long passwordPolicyId,
353                    long organizationId)
354                    throws com.liferay.portal.kernel.exception.SystemException {
355                    return getService()
356                                       .hasPasswordPolicyOrganization(passwordPolicyId,
357                            organizationId);
358            }
359    
360            public static boolean hasUserOrganization(long userId, long organizationId)
361                    throws com.liferay.portal.kernel.exception.SystemException {
362                    return getService().hasUserOrganization(userId, organizationId);
363            }
364    
365            public static boolean hasUserOrganization(long userId, long organizationId,
366                    boolean inheritSuborganizations, boolean inheritUserGroups,
367                    boolean includeSpecifiedOrganization)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService()
371                                       .hasUserOrganization(userId, organizationId,
372                            inheritSuborganizations, inheritUserGroups,
373                            includeSpecifiedOrganization);
374            }
375    
376            public static void rebuildTree(long companyId, boolean force)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    getService().rebuildTree(companyId, force);
379            }
380    
381            public static com.liferay.portal.kernel.search.Hits search(long companyId,
382                    long parentOrganizationId, java.lang.String keywords,
383                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
384                    int start, int end, com.liferay.portal.kernel.search.Sort sort)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService()
387                                       .search(companyId, parentOrganizationId, keywords, params,
388                            start, end, sort);
389            }
390    
391            public static java.util.List<com.liferay.portal.model.Organization> search(
392                    long companyId, long parentOrganizationId, java.lang.String keywords,
393                    java.lang.String type, java.lang.Long regionId,
394                    java.lang.Long countryId,
395                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
396                    int start, int end)
397                    throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService()
399                                       .search(companyId, parentOrganizationId, keywords, type,
400                            regionId, countryId, params, start, end);
401            }
402    
403            public static java.util.List<com.liferay.portal.model.Organization> search(
404                    long companyId, long parentOrganizationId, java.lang.String keywords,
405                    java.lang.String type, java.lang.Long regionId,
406                    java.lang.Long countryId,
407                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
408                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService()
411                                       .search(companyId, parentOrganizationId, keywords, type,
412                            regionId, countryId, params, start, end, obc);
413            }
414    
415            public static java.util.List<com.liferay.portal.model.Organization> search(
416                    long companyId, long parentOrganizationId, java.lang.String name,
417                    java.lang.String type, java.lang.String street, java.lang.String city,
418                    java.lang.String zip, java.lang.Long regionId,
419                    java.lang.Long countryId,
420                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
421                    boolean andOperator, int start, int end)
422                    throws com.liferay.portal.kernel.exception.SystemException {
423                    return getService()
424                                       .search(companyId, parentOrganizationId, name, type, street,
425                            city, zip, regionId, countryId, params, andOperator, start, end);
426            }
427    
428            public static java.util.List<com.liferay.portal.model.Organization> search(
429                    long companyId, long parentOrganizationId, java.lang.String name,
430                    java.lang.String type, java.lang.String street, java.lang.String city,
431                    java.lang.String zip, java.lang.Long regionId,
432                    java.lang.Long countryId,
433                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
434                    boolean andOperator, int start, int end,
435                    com.liferay.portal.kernel.util.OrderByComparator obc)
436                    throws com.liferay.portal.kernel.exception.SystemException {
437                    return getService()
438                                       .search(companyId, parentOrganizationId, name, type, street,
439                            city, zip, regionId, countryId, params, andOperator, start, end, obc);
440            }
441    
442            public static com.liferay.portal.kernel.search.Hits search(long companyId,
443                    long parentOrganizationId, java.lang.String name,
444                    java.lang.String type, java.lang.String street, java.lang.String city,
445                    java.lang.String zip, java.lang.String region,
446                    java.lang.String country,
447                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
448                    boolean andSearch, int start, int end,
449                    com.liferay.portal.kernel.search.Sort sort)
450                    throws com.liferay.portal.kernel.exception.SystemException {
451                    return getService()
452                                       .search(companyId, parentOrganizationId, name, type, street,
453                            city, zip, region, country, params, andSearch, start, end, sort);
454            }
455    
456            public static int searchCount(long companyId, long parentOrganizationId,
457                    java.lang.String keywords, java.lang.String type,
458                    java.lang.Long regionId, java.lang.Long countryId,
459                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
460                    throws com.liferay.portal.kernel.exception.SystemException {
461                    return getService()
462                                       .searchCount(companyId, parentOrganizationId, keywords,
463                            type, regionId, countryId, params);
464            }
465    
466            public static int searchCount(long companyId, long parentOrganizationId,
467                    java.lang.String name, java.lang.String type, java.lang.String street,
468                    java.lang.String city, java.lang.String zip, java.lang.Long regionId,
469                    java.lang.Long countryId,
470                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
471                    boolean andOperator)
472                    throws com.liferay.portal.kernel.exception.SystemException {
473                    return getService()
474                                       .searchCount(companyId, parentOrganizationId, name, type,
475                            street, city, zip, regionId, countryId, params, andOperator);
476            }
477    
478            public static void setGroupOrganizations(long groupId,
479                    long[] organizationIds)
480                    throws com.liferay.portal.kernel.exception.PortalException,
481                            com.liferay.portal.kernel.exception.SystemException {
482                    getService().setGroupOrganizations(groupId, organizationIds);
483            }
484    
485            public static void unsetGroupOrganizations(long groupId,
486                    long[] organizationIds)
487                    throws com.liferay.portal.kernel.exception.PortalException,
488                            com.liferay.portal.kernel.exception.SystemException {
489                    getService().unsetGroupOrganizations(groupId, organizationIds);
490            }
491    
492            public static void unsetPasswordPolicyOrganizations(long passwordPolicyId,
493                    long[] organizationIds)
494                    throws com.liferay.portal.kernel.exception.SystemException {
495                    getService()
496                            .unsetPasswordPolicyOrganizations(passwordPolicyId, organizationIds);
497            }
498    
499            public static void updateAsset(long userId,
500                    com.liferay.portal.model.Organization organization,
501                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
502                    throws com.liferay.portal.kernel.exception.PortalException,
503                            com.liferay.portal.kernel.exception.SystemException {
504                    getService()
505                            .updateAsset(userId, organization, assetCategoryIds, assetTagNames);
506            }
507    
508            public static com.liferay.portal.model.Organization updateOrganization(
509                    long companyId, long organizationId, long parentOrganizationId,
510                    java.lang.String name, java.lang.String type, boolean recursable,
511                    long regionId, long countryId, int statusId, java.lang.String comments,
512                    com.liferay.portal.service.ServiceContext serviceContext)
513                    throws com.liferay.portal.kernel.exception.PortalException,
514                            com.liferay.portal.kernel.exception.SystemException {
515                    return getService()
516                                       .updateOrganization(companyId, organizationId,
517                            parentOrganizationId, name, type, recursable, regionId, countryId,
518                            statusId, comments, serviceContext);
519            }
520    
521            public static OrganizationLocalService getService() {
522                    if (_service == null) {
523                            _service = (OrganizationLocalService)PortalBeanLocatorUtil.locate(OrganizationLocalService.class.getName());
524                    }
525    
526                    return _service;
527            }
528    
529            public void setService(OrganizationLocalService service) {
530                    _service = service;
531            }
532    
533            private static OrganizationLocalService _service;
534    }