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