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