001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    
023    /**
024     * The interface for the organization local service.
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 OrganizationLocalServiceUtil
032     * @see com.liferay.portal.service.base.OrganizationLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.OrganizationLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface OrganizationLocalService extends PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * 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.
043             */
044    
045            /**
046            * Adds the organization to the database. Also notifies the appropriate model listeners.
047            *
048            * @param organization the organization
049            * @return the organization that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.Organization addOrganization(
053                    com.liferay.portal.model.Organization organization)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new organization with the primary key. Does not add the organization to the database.
058            *
059            * @param organizationId the primary key for the new organization
060            * @return the new organization
061            */
062            public com.liferay.portal.model.Organization createOrganization(
063                    long organizationId);
064    
065            /**
066            * Deletes the organization with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param organizationId the primary key of the organization
069            * @throws PortalException if a organization with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public void deleteOrganization(long organizationId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            /**
077            * Deletes the organization from the database. Also notifies the appropriate model listeners.
078            *
079            * @param organization the organization
080            * @throws PortalException
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteOrganization(
084                    com.liferay.portal.model.Organization organization)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            /**
089            * Performs a dynamic query on the database and returns the matching rows.
090            *
091            * @param dynamicQuery the dynamic query
092            * @return the matching rows
093            * @throws SystemException if a system exception occurred
094            */
095            @SuppressWarnings("rawtypes")
096            public java.util.List dynamicQuery(
097                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
098                    throws com.liferay.portal.kernel.exception.SystemException;
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
108            * @param start the lower bound of the range of model instances
109            * @param end the upper bound of the range of model instances (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public 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    
118            /**
119            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
120            *
121            * <p>
122            * 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.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query
126            * @param start the lower bound of the range of model instances
127            * @param end the upper bound of the range of model instances (not inclusive)
128            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
129            * @return the ordered range of matching rows
130            * @throws SystemException if a system exception occurred
131            */
132            @SuppressWarnings("rawtypes")
133            public java.util.List dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end,
136                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
137                    throws com.liferay.portal.kernel.exception.SystemException;
138    
139            /**
140            * Returns the number of rows that match the dynamic query.
141            *
142            * @param dynamicQuery the dynamic query
143            * @return the number of rows that match the dynamic query
144            * @throws SystemException if a system exception occurred
145            */
146            public long dynamicQueryCount(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
148                    throws com.liferay.portal.kernel.exception.SystemException;
149    
150            /**
151            * Returns the organization with the primary key.
152            *
153            * @param organizationId the primary key of the organization
154            * @return the organization
155            * @throws PortalException if a organization with the primary key could not be found
156            * @throws SystemException if a system exception occurred
157            */
158            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
159            public com.liferay.portal.model.Organization getOrganization(
160                    long organizationId)
161                    throws com.liferay.portal.kernel.exception.PortalException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public com.liferay.portal.model.PersistedModel getPersistedModel(
166                    java.io.Serializable primaryKeyObj)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            /**
171            * Returns a range of all the organizations.
172            *
173            * <p>
174            * 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.
175            * </p>
176            *
177            * @param start the lower bound of the range of organizations
178            * @param end the upper bound of the range of organizations (not inclusive)
179            * @return the range of organizations
180            * @throws SystemException if a system exception occurred
181            */
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
184                    int start, int end)
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Returns the number of organizations.
189            *
190            * @return the number of organizations
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public int getOrganizationsCount()
195                    throws com.liferay.portal.kernel.exception.SystemException;
196    
197            /**
198            * Updates the organization in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
199            *
200            * @param organization the organization
201            * @return the organization that was updated
202            * @throws SystemException if a system exception occurred
203            */
204            public com.liferay.portal.model.Organization updateOrganization(
205                    com.liferay.portal.model.Organization organization)
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the organization in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param organization the organization
212            * @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.
213            * @return the organization that was updated
214            * @throws SystemException if a system exception occurred
215            */
216            public com.liferay.portal.model.Organization updateOrganization(
217                    com.liferay.portal.model.Organization organization, boolean merge)
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns the Spring bean ID for this bean.
222            *
223            * @return the Spring bean ID for this bean
224            */
225            public java.lang.String getBeanIdentifier();
226    
227            /**
228            * Sets the Spring bean ID for this bean.
229            *
230            * @param beanIdentifier the Spring bean ID for this bean
231            */
232            public void setBeanIdentifier(java.lang.String beanIdentifier);
233    
234            public void addGroupOrganizations(long groupId, long[] organizationIds)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            public com.liferay.portal.model.Organization addOrganization(long userId,
239                    long parentOrganizationId, java.lang.String name,
240                    java.lang.String type, boolean recursable, long regionId,
241                    long countryId, int statusId, java.lang.String comments,
242                    com.liferay.portal.service.ServiceContext serviceContext)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException;
245    
246            public void addOrganizationResources(long userId,
247                    com.liferay.portal.model.Organization organization)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException;
250    
251            public void addPasswordPolicyOrganizations(long passwordPolicyId,
252                    long[] organizationIds)
253                    throws com.liferay.portal.kernel.exception.SystemException;
254    
255            public void deleteLogo(long organizationId)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public java.util.List<com.liferay.portal.model.Organization> getGroupOrganizations(
261                    long groupId)
262                    throws com.liferay.portal.kernel.exception.SystemException;
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public com.liferay.portal.model.Organization getOrganization(
266                    long companyId, java.lang.String name)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
271            public long getOrganizationId(long companyId, java.lang.String name)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
276                    long companyId, long parentOrganizationId)
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
280            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
281                    long companyId, long parentOrganizationId, int start, int end)
282                    throws com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public 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    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public int getOrganizationsCount(long companyId, long parentOrganizationId)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public java.util.List<com.liferay.portal.model.Organization> getParentOrganizations(
296                    long organizationId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public java.util.List<com.liferay.portal.model.Organization> getSuborganizations(
302                    java.util.List<com.liferay.portal.model.Organization> organizations)
303                    throws com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public java.util.List<com.liferay.portal.model.Organization> getSubsetOrganizations(
307                    java.util.List<com.liferay.portal.model.Organization> allOrganizations,
308                    java.util.List<com.liferay.portal.model.Organization> availableOrganizations);
309    
310            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
312                    long userId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
318                    long userId, boolean inheritUserGroups)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
324                    long userId, boolean inheritUserGroups, int start, int end)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public java.util.List<com.liferay.portal.model.Organization> getUserOrganizations(
330                    long userId, int start, int end)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public int getUserOrganizationsCount(long userId)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public boolean hasGroupOrganization(long groupId, long organizationId)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public boolean hasPasswordPolicyOrganization(long passwordPolicyId,
344                    long organizationId)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public boolean hasUserOrganization(long userId, long organizationId)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public boolean hasUserOrganization(long userId, long organizationId,
353                    boolean inheritSuborganizations, boolean inheritUserGroups,
354                    boolean includeSpecifiedOrganization)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    
358            public void rebuildTree(long companyId, boolean force)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public com.liferay.portal.kernel.search.Hits search(long companyId,
363                    long parentOrganizationId, java.lang.String keywords,
364                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
365                    int start, int end, com.liferay.portal.kernel.search.Sort sort)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public java.util.List<com.liferay.portal.model.Organization> search(
370                    long companyId, long parentOrganizationId, java.lang.String keywords,
371                    java.lang.String type, java.lang.Long regionId,
372                    java.lang.Long countryId,
373                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
374                    int start, int end)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public java.util.List<com.liferay.portal.model.Organization> search(
379                    long companyId, long parentOrganizationId, java.lang.String keywords,
380                    java.lang.String type, java.lang.Long regionId,
381                    java.lang.Long countryId,
382                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
383                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
384                    throws com.liferay.portal.kernel.exception.SystemException;
385    
386            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
387            public java.util.List<com.liferay.portal.model.Organization> search(
388                    long companyId, long parentOrganizationId, java.lang.String name,
389                    java.lang.String type, java.lang.String street, java.lang.String city,
390                    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, int start, int end)
394                    throws com.liferay.portal.kernel.exception.SystemException;
395    
396            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
397            public java.util.List<com.liferay.portal.model.Organization> search(
398                    long companyId, long parentOrganizationId, java.lang.String name,
399                    java.lang.String type, java.lang.String street, java.lang.String city,
400                    java.lang.String zip, java.lang.Long regionId,
401                    java.lang.Long countryId,
402                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
403                    boolean andOperator, int start, int end,
404                    com.liferay.portal.kernel.util.OrderByComparator obc)
405                    throws com.liferay.portal.kernel.exception.SystemException;
406    
407            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
408            public com.liferay.portal.kernel.search.Hits search(long companyId,
409                    long parentOrganizationId, java.lang.String name,
410                    java.lang.String type, java.lang.String street, java.lang.String city,
411                    java.lang.String zip, java.lang.String region,
412                    java.lang.String country,
413                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
414                    boolean andSearch, int start, int end,
415                    com.liferay.portal.kernel.search.Sort sort)
416                    throws com.liferay.portal.kernel.exception.SystemException;
417    
418            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
419            public int searchCount(long companyId, long parentOrganizationId,
420                    java.lang.String keywords, java.lang.String type,
421                    java.lang.Long regionId, java.lang.Long countryId,
422                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
423                    throws com.liferay.portal.kernel.exception.SystemException;
424    
425            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
426            public int searchCount(long companyId, long parentOrganizationId,
427                    java.lang.String name, java.lang.String type, java.lang.String street,
428                    java.lang.String city, java.lang.String zip, java.lang.Long regionId,
429                    java.lang.Long countryId,
430                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
431                    boolean andOperator)
432                    throws com.liferay.portal.kernel.exception.SystemException;
433    
434            public void setGroupOrganizations(long groupId, long[] organizationIds)
435                    throws com.liferay.portal.kernel.exception.PortalException,
436                            com.liferay.portal.kernel.exception.SystemException;
437    
438            public void unsetGroupOrganizations(long groupId, long[] organizationIds)
439                    throws com.liferay.portal.kernel.exception.PortalException,
440                            com.liferay.portal.kernel.exception.SystemException;
441    
442            public void unsetPasswordPolicyOrganizations(long passwordPolicyId,
443                    long[] organizationIds)
444                    throws com.liferay.portal.kernel.exception.SystemException;
445    
446            public void updateAsset(long userId,
447                    com.liferay.portal.model.Organization organization,
448                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException;
451    
452            public com.liferay.portal.model.Organization updateOrganization(
453                    long companyId, long organizationId, long parentOrganizationId,
454                    java.lang.String name, java.lang.String type, boolean recursable,
455                    long regionId, long countryId, int statusId, java.lang.String comments,
456                    com.liferay.portal.service.ServiceContext serviceContext)
457                    throws com.liferay.portal.kernel.exception.PortalException,
458                            com.liferay.portal.kernel.exception.SystemException;
459    }