001    /**
002     * Copyright (c) 2000-2013 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    /**
018     * <p>
019     * This class is a wrapper for {@link CompanyService}.
020     * </p>
021     *
022     * @author    Brian Wing Shun Chan
023     * @see       CompanyService
024     * @generated
025     */
026    public class CompanyServiceWrapper implements CompanyService,
027            ServiceWrapper<CompanyService> {
028            public CompanyServiceWrapper(CompanyService companyService) {
029                    _companyService = companyService;
030            }
031    
032            /**
033            * Returns the Spring bean ID for this bean.
034            *
035            * @return the Spring bean ID for this bean
036            */
037            public java.lang.String getBeanIdentifier() {
038                    return _companyService.getBeanIdentifier();
039            }
040    
041            /**
042            * Sets the Spring bean ID for this bean.
043            *
044            * @param beanIdentifier the Spring bean ID for this bean
045            */
046            public void setBeanIdentifier(java.lang.String beanIdentifier) {
047                    _companyService.setBeanIdentifier(beanIdentifier);
048            }
049    
050            /**
051            * Adds a company.
052            *
053            * @param webId the company's web domain
054            * @param virtualHost the company's virtual host name
055            * @param mx the company's mail domain
056            * @param shardName the company's shard
057            * @param system whether the company is the very first company (i.e., the
058            * @param maxUsers the max number of company users (optionally
059            <code>0</code>)
060            * @param active whether the company is active
061            * @return the company
062            * @throws PortalException if the web domain, virtual host name, or mail
063            domain was invalid or if the user was not a universal
064            administrator
065            * @throws SystemException if a system exception occurred
066            */
067            public com.liferay.portal.model.Company addCompany(java.lang.String webId,
068                    java.lang.String virtualHost, java.lang.String mx,
069                    java.lang.String shardName, boolean system, int maxUsers, boolean active)
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException {
072                    return _companyService.addCompany(webId, virtualHost, mx, shardName,
073                            system, maxUsers, active);
074            }
075    
076            /**
077            * Deletes the company's logo.
078            *
079            * @param companyId the primary key of the company
080            * @throws PortalException if the company with the primary key could not be
081            found or if the company's logo could not be found or if the user
082            was not an administrator
083            * @throws SystemException if a system exception occurred
084            */
085            public void deleteLogo(long companyId)
086                    throws com.liferay.portal.kernel.exception.PortalException,
087                            com.liferay.portal.kernel.exception.SystemException {
088                    _companyService.deleteLogo(companyId);
089            }
090    
091            /**
092            * Returns the company with the primary key.
093            *
094            * @param companyId the primary key of the company
095            * @return Returns the company with the primary key
096            * @throws PortalException if a company with the primary key could not be
097            found
098            * @throws SystemException if a system exception occurred
099            */
100            public com.liferay.portal.model.Company getCompanyById(long companyId)
101                    throws com.liferay.portal.kernel.exception.PortalException,
102                            com.liferay.portal.kernel.exception.SystemException {
103                    return _companyService.getCompanyById(companyId);
104            }
105    
106            /**
107            * Returns the company with the logo.
108            *
109            * @param logoId the ID of the company's logo
110            * @return Returns the company with the logo
111            * @throws PortalException if the company with the logo could not be found
112            * @throws SystemException if a system exception occurred
113            */
114            public com.liferay.portal.model.Company getCompanyByLogoId(long logoId)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException {
117                    return _companyService.getCompanyByLogoId(logoId);
118            }
119    
120            /**
121            * Returns the company with the mail domian.
122            *
123            * @param mx the company's mail domain
124            * @return Returns the company with the mail domain
125            * @throws PortalException if the company with the mail domain could not be
126            found
127            * @throws SystemException if a system exception occurred
128            */
129            public com.liferay.portal.model.Company getCompanyByMx(java.lang.String mx)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException {
132                    return _companyService.getCompanyByMx(mx);
133            }
134    
135            /**
136            * Returns the company with the virtual host name.
137            *
138            * @param virtualHost the company's virtual host name
139            * @return Returns the company with the virtual host name
140            * @throws PortalException if the company with the virtual host name could
141            not be found or if the virtual host was not associated with a
142            company
143            * @throws SystemException if a system exception occurred
144            */
145            public com.liferay.portal.model.Company getCompanyByVirtualHost(
146                    java.lang.String virtualHost)
147                    throws com.liferay.portal.kernel.exception.PortalException,
148                            com.liferay.portal.kernel.exception.SystemException {
149                    return _companyService.getCompanyByVirtualHost(virtualHost);
150            }
151    
152            /**
153            * Returns the company with the web domain.
154            *
155            * @param webId the company's web domain
156            * @return Returns the company with the web domain
157            * @throws PortalException if the company with the web domain could not be
158            found
159            * @throws SystemException if a system exception occurred
160            */
161            public com.liferay.portal.model.Company getCompanyByWebId(
162                    java.lang.String webId)
163                    throws com.liferay.portal.kernel.exception.PortalException,
164                            com.liferay.portal.kernel.exception.SystemException {
165                    return _companyService.getCompanyByWebId(webId);
166            }
167    
168            /**
169            * Removes the values that match the keys of the company's preferences.
170            *
171            * This method is called by {@link
172            * com.liferay.portlet.portalsettings.action.EditLDAPServerAction} remotely
173            * through {@link com.liferay.portal.service.CompanyService}.
174            *
175            * @param companyId the primary key of the company
176            * @param keys the company's preferences keys to be remove
177            * @throws PortalException if the user was not an administrator
178            * @throws SystemException if a system exception occurred
179            */
180            public void removePreferences(long companyId, java.lang.String[] keys)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException {
183                    _companyService.removePreferences(companyId, keys);
184            }
185    
186            /**
187            * Updates the company
188            *
189            * @param companyId the primary key of the company
190            * @param virtualHost the company's virtual host name
191            * @param mx the company's mail domain
192            * @param maxUsers the max number of company users (optionally
193            <code>0</code>)
194            * @param active whether the company is active
195            * @return the company with the primary key
196            * @throws PortalException if a company with the primary key could not be
197            found or if the new information was invalid or if the user was
198            not a universal administrator
199            * @throws SystemException if a system exception occurred
200            */
201            public com.liferay.portal.model.Company updateCompany(long companyId,
202                    java.lang.String virtualHost, java.lang.String mx, int maxUsers,
203                    boolean active)
204                    throws com.liferay.portal.kernel.exception.PortalException,
205                            com.liferay.portal.kernel.exception.SystemException {
206                    return _companyService.updateCompany(companyId, virtualHost, mx,
207                            maxUsers, active);
208            }
209    
210            /**
211            * Updates the company with additional account information.
212            *
213            * @param companyId the primary key of the company
214            * @param virtualHost the company's virtual host name
215            * @param mx the company's mail domain
216            * @param homeURL the company's home URL (optionally <code>null</code>)
217            * @param name the company's account name (optionally <code>null</code>)
218            * @param legalName the company's account legal name (optionally
219            <code>null</code>)
220            * @param legalId the company's account legal ID (optionally
221            <code>null</code>)
222            * @param legalType the company's account legal type (optionally
223            <code>null</code>)
224            * @param sicCode the company's account SIC code (optionally
225            <code>null</code>)
226            * @param tickerSymbol the company's account ticker symbol (optionally
227            <code>null</code>)
228            * @param industry the the company's account industry (optionally
229            <code>null</code>)
230            * @param type the company's account type (optionally <code>null</code>)
231            * @param size the company's account size (optionally <code>null</code>)
232            * @return the the company with the primary key
233            * @throws PortalException if a company with the primary key could not be
234            found or if the new information was invalid or if the user was
235            not an administrator
236            * @throws SystemException if a system exception occurred
237            */
238            public com.liferay.portal.model.Company updateCompany(long companyId,
239                    java.lang.String virtualHost, java.lang.String mx,
240                    java.lang.String homeURL, java.lang.String name,
241                    java.lang.String legalName, java.lang.String legalId,
242                    java.lang.String legalType, java.lang.String sicCode,
243                    java.lang.String tickerSymbol, java.lang.String industry,
244                    java.lang.String type, java.lang.String size)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException {
247                    return _companyService.updateCompany(companyId, virtualHost, mx,
248                            homeURL, name, legalName, legalId, legalType, sicCode,
249                            tickerSymbol, industry, type, size);
250            }
251    
252            /**
253            * Updates the company with addition information.
254            *
255            * @param companyId the primary key of the company
256            * @param virtualHost the company's virtual host name
257            * @param mx the company's mail domain
258            * @param homeURL the company's home URL (optionally <code>null</code>)
259            * @param name the company's account name (optionally <code>null</code>)
260            * @param legalName the company's account legal name (optionally
261            <code>null</code>)
262            * @param legalId the company's accout legal ID (optionally
263            <code>null</code>)
264            * @param legalType the company's account legal type (optionally
265            <code>null</code>)
266            * @param sicCode the company's account SIC code (optionally
267            <code>null</code>)
268            * @param tickerSymbol the company's account ticker symbol (optionally
269            <code>null</code>)
270            * @param industry the the company's account industry (optionally
271            <code>null</code>)
272            * @param type the company's account type (optionally <code>null</code>)
273            * @param size the company's account size (optionally <code>null</code>)
274            * @param languageId the ID of the company's default user's language
275            * @param timeZoneId the ID of the company's default user's time zone
276            * @param addresses the company's addresses
277            * @param emailAddresses the company's email addresses
278            * @param phones the company's phone numbers
279            * @param websites the company's websites
280            * @param properties the company's properties
281            * @return the company with the primary key
282            * @throws PortalException the company with the primary key could not be
283            found or if the new information was invalid or if the user was
284            not an administrator
285            * @throws SystemException if a system exception occurred
286            */
287            public com.liferay.portal.model.Company updateCompany(long companyId,
288                    java.lang.String virtualHost, java.lang.String mx,
289                    java.lang.String homeURL, java.lang.String name,
290                    java.lang.String legalName, java.lang.String legalId,
291                    java.lang.String legalType, java.lang.String sicCode,
292                    java.lang.String tickerSymbol, java.lang.String industry,
293                    java.lang.String type, java.lang.String size,
294                    java.lang.String languageId, java.lang.String timeZoneId,
295                    java.util.List<com.liferay.portal.model.Address> addresses,
296                    java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
297                    java.util.List<com.liferay.portal.model.Phone> phones,
298                    java.util.List<com.liferay.portal.model.Website> websites,
299                    com.liferay.portal.kernel.util.UnicodeProperties properties)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    return _companyService.updateCompany(companyId, virtualHost, mx,
303                            homeURL, name, legalName, legalId, legalType, sicCode,
304                            tickerSymbol, industry, type, size, languageId, timeZoneId,
305                            addresses, emailAddresses, phones, websites, properties);
306            }
307    
308            /**
309            * Update the company's display.
310            *
311            * @param companyId the primary key of the company
312            * @param languageId the ID of the company's default user's language
313            * @param timeZoneId the ID of the company's default user's time zone
314            * @throws PortalException if the company's default user could not be found
315            or if the user was not an administrator
316            * @throws SystemException if a system exception occurred
317            */
318            public void updateDisplay(long companyId, java.lang.String languageId,
319                    java.lang.String timeZoneId)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    _companyService.updateDisplay(companyId, languageId, timeZoneId);
323            }
324    
325            /**
326            * Updates the company's logo.
327            *
328            * @param companyId the primary key of the company
329            * @param inputStream the input stream of the company's logo image
330            * @return the company with the primary key
331            * @throws PortalException if the company's logo ID could not be found or if
332            the logo's image was corrupted or if the user was an
333            administrator
334            * @throws SystemException if a system exception occurred
335            */
336            public com.liferay.portal.model.Company updateLogo(long companyId,
337                    java.io.InputStream inputStream)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return _companyService.updateLogo(companyId, inputStream);
341            }
342    
343            /**
344            * Updates the company's preferences. The company's default properties are
345            * found in portal.properties.
346            *
347            * @param companyId the primary key of the company
348            * @param properties the company's properties. See {@link
349            com.liferay.portal.kernel.util.UnicodeProperties}
350            * @throws PortalException if the user was not an administrator
351            * @throws SystemException if a system exception occurred
352            */
353            public void updatePreferences(long companyId,
354                    com.liferay.portal.kernel.util.UnicodeProperties properties)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException {
357                    _companyService.updatePreferences(companyId, properties);
358            }
359    
360            /**
361            * Updates the company's security properties.
362            *
363            * @param companyId the primary key of the company
364            * @param authType the company's method of authenticating users
365            * @param autoLogin whether to allow users to select the "remember me"
366            feature
367            * @param sendPassword whether to allow users to ask the company to send
368            their passwords
369            * @param strangers whether to allow strangers to create accounts to
370            register themselves in the company
371            * @param strangersWithMx whether to allow strangers to create accounts
372            with email addresses that match the company mail suffix
373            * @param strangersVerify whether to require strangers who create accounts
374            to be verified via email
375            * @param siteLogo whether to to allow site administrators to use their own
376            logo instead of the enterprise logo
377            * @throws PortalException if the user was not an administrator
378            * @throws SystemException if a system exception occurred
379            */
380            public void updateSecurity(long companyId, java.lang.String authType,
381                    boolean autoLogin, boolean sendPassword, boolean strangers,
382                    boolean strangersWithMx, boolean strangersVerify, boolean siteLogo)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    _companyService.updateSecurity(companyId, authType, autoLogin,
386                            sendPassword, strangers, strangersWithMx, strangersVerify, siteLogo);
387            }
388    
389            /**
390             * @deprecated Renamed to {@link #getWrappedService}
391             */
392            public CompanyService getWrappedCompanyService() {
393                    return _companyService;
394            }
395    
396            /**
397             * @deprecated Renamed to {@link #setWrappedService}
398             */
399            public void setWrappedCompanyService(CompanyService companyService) {
400                    _companyService = companyService;
401            }
402    
403            public CompanyService getWrappedService() {
404                    return _companyService;
405            }
406    
407            public void setWrappedService(CompanyService companyService) {
408                    _companyService = companyService;
409            }
410    
411            private CompanyService _companyService;
412    }