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