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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the organization local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link OrganizationLocalServiceUtil} to access the organization local service. Add custom service methods to {@link com.liferay.portal.service.impl.OrganizationLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see OrganizationLocalServiceUtil
036     * @see com.liferay.portal.service.base.OrganizationLocalServiceBaseImpl
037     * @see com.liferay.portal.service.impl.OrganizationLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface OrganizationLocalService {
043            /**
044            * Adds the organization to the database. Also notifies the appropriate model listeners.
045            *
046            * @param organization the organization to add
047            * @return the organization that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portal.model.Organization addOrganization(
051                    com.liferay.portal.model.Organization organization)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new organization with the primary key. Does not add the organization to the database.
056            *
057            * @param organizationId the primary key for the new organization
058            * @return the new organization
059            */
060            public com.liferay.portal.model.Organization createOrganization(
061                    long organizationId);
062    
063            /**
064            * Deletes the organization with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param organizationId the primary key of the organization to delete
067            * @throws PortalException if a organization with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteOrganization(long organizationId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
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 void deleteOrganization(
081                    com.liferay.portal.model.Organization organization)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the organization with the primary key.
148            *
149            * @param organizationId the primary key of the organization to get
150            * @return the organization
151            * @throws PortalException if a organization with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portal.model.Organization getOrganization(
156                    long organizationId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets a range of all the organizations.
162            *
163            * <p>
164            * 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.
165            * </p>
166            *
167            * @param start the lower bound of the range of organizations to return
168            * @param end the upper bound of the range of organizations to return (not inclusive)
169            * @return the range of organizations
170            * @throws SystemException if a system exception occurred
171            */
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
174                    int start, int end)
175                    throws com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Gets the number of organizations.
179            *
180            * @return the number of organizations
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public int getOrganizationsCount()
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Updates the organization in the database. Also notifies the appropriate model listeners.
189            *
190            * @param organization the organization to update
191            * @return the organization that was updated
192            * @throws SystemException if a system exception occurred
193            */
194            public com.liferay.portal.model.Organization updateOrganization(
195                    com.liferay.portal.model.Organization organization)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Updates the organization in the database. Also notifies the appropriate model listeners.
200            *
201            * @param organization the organization to update
202            * @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.
203            * @return the organization that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portal.model.Organization updateOrganization(
207                    com.liferay.portal.model.Organization organization, boolean merge)
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            public void addGroupOrganizations(long groupId, long[] organizationIds)
211                    throws com.liferay.portal.kernel.exception.PortalException,
212                            com.liferay.portal.kernel.exception.SystemException;
213    
214            public com.liferay.portal.model.Organization addOrganization(long userId,
215                    long parentOrganizationId, java.lang.String name,
216                    java.lang.String type, boolean recursable, long regionId,
217                    long countryId, int statusId, java.lang.String comments,
218                    com.liferay.portal.service.ServiceContext serviceContext)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            public void addOrganizationResources(long userId,
223                    com.liferay.portal.model.Organization organization)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            public void addPasswordPolicyOrganizations(long passwordPolicyId,
228                    long[] organizationIds)
229                    throws com.liferay.portal.kernel.exception.SystemException;
230    
231            public void deleteLogo(long organizationId)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException;
234    
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public java.util.List<com.liferay.portal.model.Organization> getGroupOrganizations(
237                    long groupId)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public com.liferay.portal.model.Organization getOrganization(
242                    long companyId, java.lang.String name)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException;
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public long getOrganizationId(long companyId, java.lang.String name)
248                    throws com.liferay.portal.kernel.exception.SystemException;
249    
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
252                    long[] organizationIds)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException;
255    
256            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257            public java.util.List<com.liferay.portal.model.Organization> getParentOrganizations(
258                    long organizationId)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException;
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public java.util.List<com.liferay.portal.model.Organization> getSuborganizations(
264                    java.util.List<com.liferay.portal.model.Organization> organizations)
265                    throws com.liferay.portal.kernel.exception.SystemException;
266    
267            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
268            public java.util.List<com.liferay.portal.model.Organization> getSubsetOrganizations(
269                    java.util.List<com.liferay.portal.model.Organization> allOrganizations,
270                    java.util.List<com.liferay.portal.model.Organization> availableOrganizations);
271    
272            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
274                    long userId)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
280                    long userId, boolean inheritUserGroups)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
286                    long userId, boolean inheritUserGroups, int start, int end)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
292                    long userId, int start, int end)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297            public int getUserOrganizationsCount(long userId)
298                    throws com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public boolean hasGroupOrganization(long groupId, long organizationId)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public boolean hasPasswordPolicyOrganization(long passwordPolicyId,
306                    long organizationId)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public boolean hasUserOrganization(long userId, long organizationId)
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public boolean hasUserOrganization(long userId, long organizationId,
315                    boolean inheritSuborganizations, boolean inheritUserGroups,
316                    boolean includeSpecifiedOrganization)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    
320            public void rebuildTree(long companyId, boolean force)
321                    throws com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public com.liferay.portal.kernel.search.Hits search(long companyId,
325                    long parentOrganizationId, java.lang.String keywords,
326                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
327                    int start, int end, com.liferay.portal.kernel.search.Sort sort)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portal.model.Organization> search(
332                    long companyId, long parentOrganizationId, java.lang.String keywords,
333                    java.lang.String type, java.lang.Long regionId,
334                    java.lang.Long countryId,
335                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
336                    int start, int end)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public java.util.List<com.liferay.portal.model.Organization> search(
341                    long companyId, long parentOrganizationId, java.lang.String keywords,
342                    java.lang.String type, java.lang.Long regionId,
343                    java.lang.Long countryId,
344                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
345                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    
348            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
349            public java.util.List<com.liferay.portal.model.Organization> search(
350                    long companyId, long parentOrganizationId, java.lang.String name,
351                    java.lang.String type, java.lang.String street, java.lang.String city,
352                    java.lang.String zip, java.lang.Long regionId,
353                    java.lang.Long countryId,
354                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
355                    boolean andOperator, int start, int end)
356                    throws com.liferay.portal.kernel.exception.SystemException;
357    
358            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359            public java.util.List<com.liferay.portal.model.Organization> search(
360                    long companyId, long parentOrganizationId, java.lang.String name,
361                    java.lang.String type, java.lang.String street, java.lang.String city,
362                    java.lang.String zip, java.lang.Long regionId,
363                    java.lang.Long countryId,
364                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
365                    boolean andOperator, int start, int end,
366                    com.liferay.portal.kernel.util.OrderByComparator obc)
367                    throws com.liferay.portal.kernel.exception.SystemException;
368    
369            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
370            public com.liferay.portal.kernel.search.Hits search(long companyId,
371                    long parentOrganizationId, java.lang.String name,
372                    java.lang.String type, java.lang.String street, java.lang.String city,
373                    java.lang.String zip, java.lang.String region,
374                    java.lang.String country,
375                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
376                    boolean andSearch, int start, int end,
377                    com.liferay.portal.kernel.search.Sort sort)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public int searchCount(long companyId, long parentOrganizationId,
382                    java.lang.String keywords, java.lang.String type,
383                    java.lang.Long regionId, java.lang.Long countryId,
384                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
385                    throws com.liferay.portal.kernel.exception.SystemException;
386    
387            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
388            public int searchCount(long companyId, long parentOrganizationId,
389                    java.lang.String name, java.lang.String type, java.lang.String street,
390                    java.lang.String city, java.lang.String zip, java.lang.Long regionId,
391                    java.lang.Long countryId,
392                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
393                    boolean andOperator)
394                    throws com.liferay.portal.kernel.exception.SystemException;
395    
396            public void setGroupOrganizations(long groupId, long[] organizationIds)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException;
399    
400            public void unsetGroupOrganizations(long groupId, long[] organizationIds)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException;
403    
404            public void unsetPasswordPolicyOrganizations(long passwordPolicyId,
405                    long[] organizationIds)
406                    throws com.liferay.portal.kernel.exception.SystemException;
407    
408            public void updateAsset(long userId,
409                    com.liferay.portal.model.Organization organization,
410                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException;
413    
414            public com.liferay.portal.model.Organization updateOrganization(
415                    long companyId, long organizationId, long parentOrganizationId,
416                    java.lang.String name, java.lang.String type, boolean recursable,
417                    long regionId, long countryId, int statusId, java.lang.String comments,
418                    com.liferay.portal.service.ServiceContext serviceContext)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException;
421    }