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.portlet.dynamicdatamapping.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.service.ServiceWrapper; 020 021 /** 022 * Provides a wrapper for {@link DDMStructureLocalService}. 023 * 024 * @author Brian Wing Shun Chan 025 * @see DDMStructureLocalService 026 * @generated 027 */ 028 @ProviderType 029 public class DDMStructureLocalServiceWrapper implements DDMStructureLocalService, 030 ServiceWrapper<DDMStructureLocalService> { 031 public DDMStructureLocalServiceWrapper( 032 DDMStructureLocalService ddmStructureLocalService) { 033 _ddmStructureLocalService = ddmStructureLocalService; 034 } 035 036 /** 037 * Adds the d d m structure to the database. Also notifies the appropriate model listeners. 038 * 039 * @param ddmStructure the d d m structure 040 * @return the d d m structure that was added 041 * @throws SystemException if a system exception occurred 042 */ 043 @Override 044 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addDDMStructure( 045 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure) 046 throws com.liferay.portal.kernel.exception.SystemException { 047 return _ddmStructureLocalService.addDDMStructure(ddmStructure); 048 } 049 050 /** 051 * Creates a new d d m structure with the primary key. Does not add the d d m structure to the database. 052 * 053 * @param structureId the primary key for the new d d m structure 054 * @return the new d d m structure 055 */ 056 @Override 057 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure createDDMStructure( 058 long structureId) { 059 return _ddmStructureLocalService.createDDMStructure(structureId); 060 } 061 062 /** 063 * Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners. 064 * 065 * @param structureId the primary key of the d d m structure 066 * @return the d d m structure that was removed 067 * @throws PortalException if a d d m structure with the primary key could not be found 068 * @throws SystemException if a system exception occurred 069 */ 070 @Override 071 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure( 072 long structureId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 return _ddmStructureLocalService.deleteDDMStructure(structureId); 076 } 077 078 /** 079 * Deletes the d d m structure from the database. Also notifies the appropriate model listeners. 080 * 081 * @param ddmStructure the d d m structure 082 * @return the d d m structure that was removed 083 * @throws SystemException if a system exception occurred 084 */ 085 @Override 086 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure( 087 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return _ddmStructureLocalService.deleteDDMStructure(ddmStructure); 090 } 091 092 @Override 093 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 094 return _ddmStructureLocalService.dynamicQuery(); 095 } 096 097 /** 098 * Performs a dynamic query on the database and returns the matching rows. 099 * 100 * @param dynamicQuery the dynamic query 101 * @return the matching rows 102 * @throws SystemException if a system exception occurred 103 */ 104 @Override 105 @SuppressWarnings("rawtypes") 106 public java.util.List dynamicQuery( 107 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 108 throws com.liferay.portal.kernel.exception.SystemException { 109 return _ddmStructureLocalService.dynamicQuery(dynamicQuery); 110 } 111 112 /** 113 * Performs a dynamic query on the database and returns a range of the matching rows. 114 * 115 * <p> 116 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query 120 * @param start the lower bound of the range of model instances 121 * @param end the upper bound of the range of model instances (not inclusive) 122 * @return the range of matching rows 123 * @throws SystemException if a system exception occurred 124 */ 125 @Override 126 @SuppressWarnings("rawtypes") 127 public java.util.List dynamicQuery( 128 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 129 int end) throws com.liferay.portal.kernel.exception.SystemException { 130 return _ddmStructureLocalService.dynamicQuery(dynamicQuery, start, end); 131 } 132 133 /** 134 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 135 * 136 * <p> 137 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 138 * </p> 139 * 140 * @param dynamicQuery the dynamic query 141 * @param start the lower bound of the range of model instances 142 * @param end the upper bound of the range of model instances (not inclusive) 143 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 144 * @return the ordered range of matching rows 145 * @throws SystemException if a system exception occurred 146 */ 147 @Override 148 @SuppressWarnings("rawtypes") 149 public java.util.List dynamicQuery( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 151 int end, 152 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 153 throws com.liferay.portal.kernel.exception.SystemException { 154 return _ddmStructureLocalService.dynamicQuery(dynamicQuery, start, end, 155 orderByComparator); 156 } 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @return the number of rows that match the dynamic query 163 * @throws SystemException if a system exception occurred 164 */ 165 @Override 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 168 throws com.liferay.portal.kernel.exception.SystemException { 169 return _ddmStructureLocalService.dynamicQueryCount(dynamicQuery); 170 } 171 172 /** 173 * Returns the number of rows that match the dynamic query. 174 * 175 * @param dynamicQuery the dynamic query 176 * @param projection the projection to apply to the query 177 * @return the number of rows that match the dynamic query 178 * @throws SystemException if a system exception occurred 179 */ 180 @Override 181 public long dynamicQueryCount( 182 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 183 com.liferay.portal.kernel.dao.orm.Projection projection) 184 throws com.liferay.portal.kernel.exception.SystemException { 185 return _ddmStructureLocalService.dynamicQueryCount(dynamicQuery, 186 projection); 187 } 188 189 @Override 190 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructure( 191 long structureId) 192 throws com.liferay.portal.kernel.exception.SystemException { 193 return _ddmStructureLocalService.fetchDDMStructure(structureId); 194 } 195 196 /** 197 * Returns the d d m structure with the matching UUID and company. 198 * 199 * @param uuid the d d m structure's UUID 200 * @param companyId the primary key of the company 201 * @return the matching d d m structure, or <code>null</code> if a matching d d m structure could not be found 202 * @throws SystemException if a system exception occurred 203 */ 204 @Override 205 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructureByUuidAndCompanyId( 206 java.lang.String uuid, long companyId) 207 throws com.liferay.portal.kernel.exception.SystemException { 208 return _ddmStructureLocalService.fetchDDMStructureByUuidAndCompanyId(uuid, 209 companyId); 210 } 211 212 /** 213 * Returns the d d m structure matching the UUID and group. 214 * 215 * @param uuid the d d m structure's UUID 216 * @param groupId the primary key of the group 217 * @return the matching d d m structure, or <code>null</code> if a matching d d m structure could not be found 218 * @throws SystemException if a system exception occurred 219 */ 220 @Override 221 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructureByUuidAndGroupId( 222 java.lang.String uuid, long groupId) 223 throws com.liferay.portal.kernel.exception.SystemException { 224 return _ddmStructureLocalService.fetchDDMStructureByUuidAndGroupId(uuid, 225 groupId); 226 } 227 228 /** 229 * Returns the d d m structure with the primary key. 230 * 231 * @param structureId the primary key of the d d m structure 232 * @return the d d m structure 233 * @throws PortalException if a d d m structure with the primary key could not be found 234 * @throws SystemException if a system exception occurred 235 */ 236 @Override 237 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructure( 238 long structureId) 239 throws com.liferay.portal.kernel.exception.PortalException, 240 com.liferay.portal.kernel.exception.SystemException { 241 return _ddmStructureLocalService.getDDMStructure(structureId); 242 } 243 244 @Override 245 public com.liferay.portal.model.PersistedModel getPersistedModel( 246 java.io.Serializable primaryKeyObj) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException { 249 return _ddmStructureLocalService.getPersistedModel(primaryKeyObj); 250 } 251 252 /** 253 * Returns the d d m structure with the matching UUID and company. 254 * 255 * @param uuid the d d m structure's UUID 256 * @param companyId the primary key of the company 257 * @return the matching d d m structure 258 * @throws PortalException if a matching d d m structure could not be found 259 * @throws SystemException if a system exception occurred 260 */ 261 @Override 262 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructureByUuidAndCompanyId( 263 java.lang.String uuid, long companyId) 264 throws com.liferay.portal.kernel.exception.PortalException, 265 com.liferay.portal.kernel.exception.SystemException { 266 return _ddmStructureLocalService.getDDMStructureByUuidAndCompanyId(uuid, 267 companyId); 268 } 269 270 /** 271 * Returns the d d m structure matching the UUID and group. 272 * 273 * @param uuid the d d m structure's UUID 274 * @param groupId the primary key of the group 275 * @return the matching d d m structure 276 * @throws PortalException if a matching d d m structure could not be found 277 * @throws SystemException if a system exception occurred 278 */ 279 @Override 280 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructureByUuidAndGroupId( 281 java.lang.String uuid, long groupId) 282 throws com.liferay.portal.kernel.exception.PortalException, 283 com.liferay.portal.kernel.exception.SystemException { 284 return _ddmStructureLocalService.getDDMStructureByUuidAndGroupId(uuid, 285 groupId); 286 } 287 288 /** 289 * Returns a range of all the d d m structures. 290 * 291 * <p> 292 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 293 * </p> 294 * 295 * @param start the lower bound of the range of d d m structures 296 * @param end the upper bound of the range of d d m structures (not inclusive) 297 * @return the range of d d m structures 298 * @throws SystemException if a system exception occurred 299 */ 300 @Override 301 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructures( 302 int start, int end) 303 throws com.liferay.portal.kernel.exception.SystemException { 304 return _ddmStructureLocalService.getDDMStructures(start, end); 305 } 306 307 /** 308 * Returns the number of d d m structures. 309 * 310 * @return the number of d d m structures 311 * @throws SystemException if a system exception occurred 312 */ 313 @Override 314 public int getDDMStructuresCount() 315 throws com.liferay.portal.kernel.exception.SystemException { 316 return _ddmStructureLocalService.getDDMStructuresCount(); 317 } 318 319 /** 320 * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 321 * 322 * @param ddmStructure the d d m structure 323 * @return the d d m structure that was updated 324 * @throws SystemException if a system exception occurred 325 */ 326 @Override 327 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure( 328 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure) 329 throws com.liferay.portal.kernel.exception.SystemException { 330 return _ddmStructureLocalService.updateDDMStructure(ddmStructure); 331 } 332 333 /** 334 * @throws SystemException if a system exception occurred 335 */ 336 @Override 337 public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId, 338 long structureId) 339 throws com.liferay.portal.kernel.exception.SystemException { 340 _ddmStructureLocalService.addDLFileEntryTypeDDMStructure(fileEntryTypeId, 341 structureId); 342 } 343 344 /** 345 * @throws SystemException if a system exception occurred 346 */ 347 @Override 348 public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId, 349 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure) 350 throws com.liferay.portal.kernel.exception.SystemException { 351 _ddmStructureLocalService.addDLFileEntryTypeDDMStructure(fileEntryTypeId, 352 ddmStructure); 353 } 354 355 /** 356 * @throws SystemException if a system exception occurred 357 */ 358 @Override 359 public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId, 360 long[] structureIds) 361 throws com.liferay.portal.kernel.exception.SystemException { 362 _ddmStructureLocalService.addDLFileEntryTypeDDMStructures(fileEntryTypeId, 363 structureIds); 364 } 365 366 /** 367 * @throws SystemException if a system exception occurred 368 */ 369 @Override 370 public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId, 371 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> DDMStructures) 372 throws com.liferay.portal.kernel.exception.SystemException { 373 _ddmStructureLocalService.addDLFileEntryTypeDDMStructures(fileEntryTypeId, 374 DDMStructures); 375 } 376 377 /** 378 * @throws SystemException if a system exception occurred 379 */ 380 @Override 381 public void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId) 382 throws com.liferay.portal.kernel.exception.SystemException { 383 _ddmStructureLocalService.clearDLFileEntryTypeDDMStructures(fileEntryTypeId); 384 } 385 386 /** 387 * @throws SystemException if a system exception occurred 388 */ 389 @Override 390 public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, 391 long structureId) 392 throws com.liferay.portal.kernel.exception.SystemException { 393 _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructure(fileEntryTypeId, 394 structureId); 395 } 396 397 /** 398 * @throws SystemException if a system exception occurred 399 */ 400 @Override 401 public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, 402 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure) 403 throws com.liferay.portal.kernel.exception.SystemException { 404 _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructure(fileEntryTypeId, 405 ddmStructure); 406 } 407 408 /** 409 * @throws SystemException if a system exception occurred 410 */ 411 @Override 412 public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, 413 long[] structureIds) 414 throws com.liferay.portal.kernel.exception.SystemException { 415 _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructures(fileEntryTypeId, 416 structureIds); 417 } 418 419 /** 420 * @throws SystemException if a system exception occurred 421 */ 422 @Override 423 public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, 424 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> DDMStructures) 425 throws com.liferay.portal.kernel.exception.SystemException { 426 _ddmStructureLocalService.deleteDLFileEntryTypeDDMStructures(fileEntryTypeId, 427 DDMStructures); 428 } 429 430 /** 431 * @throws SystemException if a system exception occurred 432 */ 433 @Override 434 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures( 435 long fileEntryTypeId) 436 throws com.liferay.portal.kernel.exception.SystemException { 437 return _ddmStructureLocalService.getDLFileEntryTypeDDMStructures(fileEntryTypeId); 438 } 439 440 /** 441 * @throws SystemException if a system exception occurred 442 */ 443 @Override 444 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures( 445 long fileEntryTypeId, int start, int end) 446 throws com.liferay.portal.kernel.exception.SystemException { 447 return _ddmStructureLocalService.getDLFileEntryTypeDDMStructures(fileEntryTypeId, 448 start, end); 449 } 450 451 /** 452 * @throws SystemException if a system exception occurred 453 */ 454 @Override 455 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures( 456 long fileEntryTypeId, int start, int end, 457 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 458 throws com.liferay.portal.kernel.exception.SystemException { 459 return _ddmStructureLocalService.getDLFileEntryTypeDDMStructures(fileEntryTypeId, 460 start, end, orderByComparator); 461 } 462 463 /** 464 * @throws SystemException if a system exception occurred 465 */ 466 @Override 467 public int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId) 468 throws com.liferay.portal.kernel.exception.SystemException { 469 return _ddmStructureLocalService.getDLFileEntryTypeDDMStructuresCount(fileEntryTypeId); 470 } 471 472 /** 473 * @throws SystemException if a system exception occurred 474 */ 475 @Override 476 public boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId, 477 long structureId) 478 throws com.liferay.portal.kernel.exception.SystemException { 479 return _ddmStructureLocalService.hasDLFileEntryTypeDDMStructure(fileEntryTypeId, 480 structureId); 481 } 482 483 /** 484 * @throws SystemException if a system exception occurred 485 */ 486 @Override 487 public boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId) 488 throws com.liferay.portal.kernel.exception.SystemException { 489 return _ddmStructureLocalService.hasDLFileEntryTypeDDMStructures(fileEntryTypeId); 490 } 491 492 /** 493 * @throws SystemException if a system exception occurred 494 */ 495 @Override 496 public void setDLFileEntryTypeDDMStructures(long fileEntryTypeId, 497 long[] structureIds) 498 throws com.liferay.portal.kernel.exception.SystemException { 499 _ddmStructureLocalService.setDLFileEntryTypeDDMStructures(fileEntryTypeId, 500 structureIds); 501 } 502 503 /** 504 * Returns the Spring bean ID for this bean. 505 * 506 * @return the Spring bean ID for this bean 507 */ 508 @Override 509 public java.lang.String getBeanIdentifier() { 510 return _ddmStructureLocalService.getBeanIdentifier(); 511 } 512 513 /** 514 * Sets the Spring bean ID for this bean. 515 * 516 * @param beanIdentifier the Spring bean ID for this bean 517 */ 518 @Override 519 public void setBeanIdentifier(java.lang.String beanIdentifier) { 520 _ddmStructureLocalService.setBeanIdentifier(beanIdentifier); 521 } 522 523 /** 524 * Adds a structure referencing its parent structure. 525 * 526 * @param userId the primary key of the structure's creator/owner 527 * @param groupId the primary key of the group 528 * @param parentStructureId the primary key of the parent structure 529 (optionally {@link 530 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants#DEFAULT_PARENT_STRUCTURE_ID}) 531 * @param classNameId the primary key of the class name for the structure's 532 related model 533 * @param structureKey the unique string identifying the structure 534 (optionally <code>null</code>) 535 * @param nameMap the structure's locales and localized names 536 * @param descriptionMap the structure's locales and localized descriptions 537 * @param xsd the structure's XML schema definition 538 * @param storageType the structure's storage type. It can be "xml" or 539 "expando". For more information, see {@link 540 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 541 * @param type the structure's type. For more information, see {@link 542 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 543 * @param serviceContext the service context to be applied. Can set the 544 UUID, creation date, modification date, guest permissions, and 545 group permissions for the structure. 546 * @return the structure 547 * @throws PortalException if a user with the primary key could not be 548 found, if the XSD was not well-formed, or if a portal exception 549 occurred 550 * @throws SystemException if a system exception occurred 551 */ 552 @Override 553 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 554 long userId, long groupId, long parentStructureId, long classNameId, 555 java.lang.String structureKey, 556 java.util.Map<java.util.Locale, java.lang.String> nameMap, 557 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 558 java.lang.String xsd, java.lang.String storageType, int type, 559 com.liferay.portal.service.ServiceContext serviceContext) 560 throws com.liferay.portal.kernel.exception.PortalException, 561 com.liferay.portal.kernel.exception.SystemException { 562 return _ddmStructureLocalService.addStructure(userId, groupId, 563 parentStructureId, classNameId, structureKey, nameMap, 564 descriptionMap, xsd, storageType, type, serviceContext); 565 } 566 567 /** 568 * Adds a structure referencing a default parent structure, using the portal 569 * property <code>dynamic.data.lists.storage.type</code> storage type and 570 * default structure type. 571 * 572 * @param userId the primary key of the structure's creator/owner 573 * @param groupId the primary key of the group 574 * @param classNameId the primary key of the class name for the structure's 575 related model 576 * @param nameMap the structure's locales and localized names 577 * @param descriptionMap the structure's locales and localized descriptions 578 * @param xsd the structure's XML schema definition 579 * @param serviceContext the service context to be applied. Can set the 580 UUID, creation date, modification date, guest permissions, and 581 group permissions for the structure. 582 * @return the structure 583 * @throws PortalException if a user with the primary key could not be 584 found, if the XSD was not well-formed, or if a portal exception 585 occurred 586 * @throws SystemException if a system exception occurred 587 */ 588 @Override 589 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 590 long userId, long groupId, long classNameId, 591 java.util.Map<java.util.Locale, java.lang.String> nameMap, 592 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 593 java.lang.String xsd, 594 com.liferay.portal.service.ServiceContext serviceContext) 595 throws com.liferay.portal.kernel.exception.PortalException, 596 com.liferay.portal.kernel.exception.SystemException { 597 return _ddmStructureLocalService.addStructure(userId, groupId, 598 classNameId, nameMap, descriptionMap, xsd, serviceContext); 599 } 600 601 /** 602 * Adds a structure referencing a default parent structure if the parent 603 * structure is not found. 604 * 605 * @param userId the primary key of the structure's creator/owner 606 * @param groupId the primary key of the group 607 * @param parentStructureKey the unique string identifying the parent 608 structure (optionally <code>null</code>) 609 * @param classNameId the primary key of the class name for the structure's 610 related model 611 * @param structureKey the unique string identifying the structure 612 (optionally <code>null</code>) 613 * @param nameMap the structure's locales and localized names 614 * @param descriptionMap the structure's locales and localized descriptions 615 * @param xsd the structure's XML schema definition 616 * @param storageType the structure's storage type. It can be "xml" or 617 "expando". For more information, see {@link 618 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 619 * @param type the structure's type. For more information, see {@link 620 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 621 * @param serviceContext the service context to be applied. Can set the 622 UUID, creation date, modification date, guest permissions and 623 group permissions for the structure. 624 * @return the structure 625 * @throws PortalException if a user with the primary key could not be 626 found, if the XSD was not well-formed, or if a portal exception 627 occurred 628 * @throws SystemException if a system exception occurred 629 */ 630 @Override 631 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 632 long userId, long groupId, java.lang.String parentStructureKey, 633 long classNameId, java.lang.String structureKey, 634 java.util.Map<java.util.Locale, java.lang.String> nameMap, 635 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 636 java.lang.String xsd, java.lang.String storageType, int type, 637 com.liferay.portal.service.ServiceContext serviceContext) 638 throws com.liferay.portal.kernel.exception.PortalException, 639 com.liferay.portal.kernel.exception.SystemException { 640 return _ddmStructureLocalService.addStructure(userId, groupId, 641 parentStructureKey, classNameId, structureKey, nameMap, 642 descriptionMap, xsd, storageType, type, serviceContext); 643 } 644 645 /** 646 * Adds the resources to the structure. 647 * 648 * @param structure the structure to add resources to 649 * @param addGroupPermissions whether to add group permissions 650 * @param addGuestPermissions whether to add guest permissions 651 * @throws PortalException if a portal exception occurred 652 * @throws SystemException if a system exception occurred 653 */ 654 @Override 655 public void addStructureResources( 656 com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure, 657 boolean addGroupPermissions, boolean addGuestPermissions) 658 throws com.liferay.portal.kernel.exception.PortalException, 659 com.liferay.portal.kernel.exception.SystemException { 660 _ddmStructureLocalService.addStructureResources(structure, 661 addGroupPermissions, addGuestPermissions); 662 } 663 664 /** 665 * Adds the model resources with the permissions to the structure. 666 * 667 * @param structure the structure to add resources to 668 * @param groupPermissions the group permissions to be added 669 * @param guestPermissions the guest permissions to be added 670 * @throws PortalException if a portal exception occurred 671 * @throws SystemException if a system exception occurred 672 */ 673 @Override 674 public void addStructureResources( 675 com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure, 676 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 677 throws com.liferay.portal.kernel.exception.PortalException, 678 com.liferay.portal.kernel.exception.SystemException { 679 _ddmStructureLocalService.addStructureResources(structure, 680 groupPermissions, guestPermissions); 681 } 682 683 /** 684 * Copies a structure, creating a new structure with all the values 685 * extracted from the original one. The new structure supports a new name 686 * and description. 687 * 688 * @param userId the primary key of the structure's creator/owner 689 * @param structureId the primary key of the structure to be copied 690 * @param nameMap the new structure's locales and localized names 691 * @param descriptionMap the new structure's locales and localized 692 descriptions 693 * @param serviceContext the service context to be applied. Can set the 694 UUID, creation date, modification date, guest permissions, and 695 group permissions for the structure. 696 * @return the new structure 697 * @throws PortalException if a portal exception occurred 698 * @throws SystemException if a system exception occurred 699 */ 700 @Override 701 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure( 702 long userId, long structureId, 703 java.util.Map<java.util.Locale, java.lang.String> nameMap, 704 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 705 com.liferay.portal.service.ServiceContext serviceContext) 706 throws com.liferay.portal.kernel.exception.PortalException, 707 com.liferay.portal.kernel.exception.SystemException { 708 return _ddmStructureLocalService.copyStructure(userId, structureId, 709 nameMap, descriptionMap, serviceContext); 710 } 711 712 @Override 713 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure( 714 long userId, long structureId, 715 com.liferay.portal.service.ServiceContext serviceContext) 716 throws com.liferay.portal.kernel.exception.PortalException, 717 com.liferay.portal.kernel.exception.SystemException { 718 return _ddmStructureLocalService.copyStructure(userId, structureId, 719 serviceContext); 720 } 721 722 /** 723 * Deletes the structure and its resources. 724 * 725 * <p> 726 * Before deleting the structure, this method verifies whether the structure 727 * is required by another entity. If it is needed, an exception is thrown. 728 * </p> 729 * 730 * @param structure the structure to be deleted 731 * @throws PortalException if a portal exception occurred 732 * @throws SystemException if a system exception occurred 733 */ 734 @Override 735 public void deleteStructure( 736 com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure) 737 throws com.liferay.portal.kernel.exception.PortalException, 738 com.liferay.portal.kernel.exception.SystemException { 739 _ddmStructureLocalService.deleteStructure(structure); 740 } 741 742 /** 743 * Deletes the structure and its resources. 744 * 745 * <p> 746 * Before deleting the structure, the system verifies whether the structure 747 * is required by another entity. If it is needed, an exception is thrown. 748 * </p> 749 * 750 * @param structureId the primary key of the structure to be deleted 751 * @throws PortalException if a portal exception occurred 752 * @throws SystemException if a system exception occurred 753 */ 754 @Override 755 public void deleteStructure(long structureId) 756 throws com.liferay.portal.kernel.exception.PortalException, 757 com.liferay.portal.kernel.exception.SystemException { 758 _ddmStructureLocalService.deleteStructure(structureId); 759 } 760 761 /** 762 * Deletes the matching structure and its resources. 763 * 764 * <p> 765 * Before deleting the structure, the system verifies whether the structure 766 * is required by another entity. If it is needed, an exception is thrown. 767 * </p> 768 * 769 * @param groupId the primary key of the group 770 * @param classNameId the primary key of the class name for the structure's 771 related model 772 * @param structureKey the unique string identifying the structure 773 * @throws PortalException if a portal exception occurred 774 * @throws SystemException if a system exception occurred 775 */ 776 @Override 777 public void deleteStructure(long groupId, long classNameId, 778 java.lang.String structureKey) 779 throws com.liferay.portal.kernel.exception.PortalException, 780 com.liferay.portal.kernel.exception.SystemException { 781 _ddmStructureLocalService.deleteStructure(groupId, classNameId, 782 structureKey); 783 } 784 785 /** 786 * Deletes all the structures of the group. 787 * 788 * <p> 789 * Before deleting the structures, the system verifies whether each 790 * structure is required by another entity. If any of the structures are 791 * needed, an exception is thrown. 792 * </p> 793 * 794 * @param groupId the primary key of the group 795 * @throws PortalException if a portal exception occurred 796 * @throws SystemException if a system exception occurred 797 */ 798 @Override 799 public void deleteStructures(long groupId) 800 throws com.liferay.portal.kernel.exception.PortalException, 801 com.liferay.portal.kernel.exception.SystemException { 802 _ddmStructureLocalService.deleteStructures(groupId); 803 } 804 805 /** 806 * Returns the structure with the ID. 807 * 808 * @param structureId the primary key of the structure 809 * @return the structure with the structure ID, or <code>null</code> if a 810 matching structure could not be found 811 * @throws SystemException if a system exception occurred 812 */ 813 @Override 814 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 815 long structureId) 816 throws com.liferay.portal.kernel.exception.SystemException { 817 return _ddmStructureLocalService.fetchStructure(structureId); 818 } 819 820 /** 821 * Returns the structure matching the class name ID, structure key, and 822 * group. 823 * 824 * @param groupId the primary key of the group 825 * @param classNameId the primary key of the class name for the structure's 826 related model 827 * @param structureKey the unique string identifying the structure 828 * @return the matching structure, or <code>null</code> if a matching 829 structure could not be found 830 * @throws SystemException if a system exception occurred 831 */ 832 @Override 833 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 834 long groupId, long classNameId, java.lang.String structureKey) 835 throws com.liferay.portal.kernel.exception.SystemException { 836 return _ddmStructureLocalService.fetchStructure(groupId, classNameId, 837 structureKey); 838 } 839 840 /** 841 * Returns the structure matching the class name ID, structure key, and 842 * group, optionally in the global scope. 843 * 844 * <p> 845 * This method first searches in the group. If the structure is still not 846 * found and <code>includeGlobalStructures</code> is set to 847 * <code>true</code>, this method searches the global group. 848 * </p> 849 * 850 * @param groupId the primary key of the group 851 * @param classNameId the primary key of the class name for the structure's 852 related model 853 * @param structureKey the unique string identifying the structure 854 * @param includeGlobalStructures whether to include the global scope in 855 the search 856 * @return the matching structure, or <code>null</code> if a matching 857 structure could not be found 858 * @throws PortalException if a portal exception occurred 859 * @throws SystemException if a system exception occurred 860 */ 861 @Override 862 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 863 long groupId, long classNameId, java.lang.String structureKey, 864 boolean includeGlobalStructures) 865 throws com.liferay.portal.kernel.exception.PortalException, 866 com.liferay.portal.kernel.exception.SystemException { 867 return _ddmStructureLocalService.fetchStructure(groupId, classNameId, 868 structureKey, includeGlobalStructures); 869 } 870 871 /** 872 * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long, 873 long)} 874 */ 875 @Override 876 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 877 long classNameId) 878 throws com.liferay.portal.kernel.exception.SystemException { 879 return _ddmStructureLocalService.getClassStructures(classNameId); 880 } 881 882 /** 883 * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long, 884 long, int, int)} 885 */ 886 @Override 887 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 888 long classNameId, int start, int end) 889 throws com.liferay.portal.kernel.exception.SystemException { 890 return _ddmStructureLocalService.getClassStructures(classNameId, start, 891 end); 892 } 893 894 /** 895 * Returns all the structures matching the class name ID. 896 * 897 * @param companyId the primary key of the structure's company 898 * @param classNameId the primary key of the class name for the structure's 899 related model 900 * @return the structures matching the class name ID 901 * @throws SystemException if a system exception occurred 902 */ 903 @Override 904 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 905 long companyId, long classNameId) 906 throws com.liferay.portal.kernel.exception.SystemException { 907 return _ddmStructureLocalService.getClassStructures(companyId, 908 classNameId); 909 } 910 911 /** 912 * Returns a range of all the structures matching the class name ID. 913 * 914 * <p> 915 * Useful when paginating results. Returns a maximum of <code>end - 916 * start</code> instances. <code>start</code> and <code>end</code> are not 917 * primary keys, they are indexes in the result set. Thus, <code>0</code> 918 * refers to the first result in the set. Setting both <code>start</code> 919 * and <code>end</code> to {@link 920 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 921 * result set. 922 * </p> 923 * 924 * @param companyId the primary key of the structure's company 925 * @param classNameId the primary key of the class name for the structure's 926 related model 927 * @param start the lower bound of the range of structures to return 928 * @param end the upper bound of the range of structures to return (not 929 inclusive) 930 * @return the range of matching structures 931 * @throws SystemException if a system exception occurred 932 */ 933 @Override 934 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 935 long companyId, long classNameId, int start, int end) 936 throws com.liferay.portal.kernel.exception.SystemException { 937 return _ddmStructureLocalService.getClassStructures(companyId, 938 classNameId, start, end); 939 } 940 941 /** 942 * Returns all the structures matching the class name ID ordered by the 943 * comparator. 944 * 945 * @param companyId the primary key of the structure's company 946 * @param classNameId the primary key of the class name for the structure's 947 related model 948 * @param orderByComparator the comparator to order the structures 949 (optionally <code>null</code>) 950 * @return the matching structures ordered by the comparator 951 * @throws SystemException if a system exception occurred 952 */ 953 @Override 954 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 955 long companyId, long classNameId, 956 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 957 throws com.liferay.portal.kernel.exception.SystemException { 958 return _ddmStructureLocalService.getClassStructures(companyId, 959 classNameId, orderByComparator); 960 } 961 962 /** 963 * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long, 964 long, OrderByComparator)} 965 */ 966 @Override 967 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 968 long classNameId, 969 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 970 throws com.liferay.portal.kernel.exception.SystemException { 971 return _ddmStructureLocalService.getClassStructures(classNameId, 972 orderByComparator); 973 } 974 975 /** 976 * Returns all the structures for the document library file entry type. 977 * 978 * @param dlFileEntryTypeId the primary key of the document library file 979 entry type 980 * @return the structures for the document library file entry type 981 * @throws SystemException if a system exception occurred 982 */ 983 @Override 984 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures( 985 long dlFileEntryTypeId) 986 throws com.liferay.portal.kernel.exception.SystemException { 987 return _ddmStructureLocalService.getDLFileEntryTypeStructures(dlFileEntryTypeId); 988 } 989 990 /** 991 * Returns the structure with the ID. 992 * 993 * @param structureId the primary key of the structure 994 * @return the structure with the ID 995 * @throws PortalException if a structure with the ID could not be found 996 * @throws SystemException if a system exception occurred 997 */ 998 @Override 999 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 1000 long structureId) 1001 throws com.liferay.portal.kernel.exception.PortalException, 1002 com.liferay.portal.kernel.exception.SystemException { 1003 return _ddmStructureLocalService.getStructure(structureId); 1004 } 1005 1006 /** 1007 * Returns the structure matching the class name ID, structure key, and 1008 * group. 1009 * 1010 * @param groupId the primary key of the structure's group 1011 * @param classNameId the primary key of the class name for the structure's 1012 related model 1013 * @param structureKey the unique string identifying the structure 1014 * @return the matching structure 1015 * @throws PortalException if a matching structure could not be found 1016 * @throws SystemException if a system exception occurred 1017 */ 1018 @Override 1019 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 1020 long groupId, long classNameId, java.lang.String structureKey) 1021 throws com.liferay.portal.kernel.exception.PortalException, 1022 com.liferay.portal.kernel.exception.SystemException { 1023 return _ddmStructureLocalService.getStructure(groupId, classNameId, 1024 structureKey); 1025 } 1026 1027 /** 1028 * Returns the structure matching the class name ID, structure key, and 1029 * group, optionally in the global scope. 1030 * 1031 * <p> 1032 * This method first searches in the group. If the structure is still not 1033 * found and <code>includeGlobalStructures</code> is set to 1034 * <code>true</code>, this method searches the global group. 1035 * </p> 1036 * 1037 * @param groupId the primary key of the structure's group 1038 * @param classNameId the primary key of the class name for the structure's 1039 related model 1040 * @param structureKey the unique string identifying the structure 1041 * @param includeGlobalStructures whether to include the global scope in 1042 the search 1043 * @return the matching structure 1044 * @throws PortalException if a matching structure could not be found 1045 * @throws SystemException if a system exception occurred 1046 */ 1047 @Override 1048 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 1049 long groupId, long classNameId, java.lang.String structureKey, 1050 boolean includeGlobalStructures) 1051 throws com.liferay.portal.kernel.exception.PortalException, 1052 com.liferay.portal.kernel.exception.SystemException { 1053 return _ddmStructureLocalService.getStructure(groupId, classNameId, 1054 structureKey, includeGlobalStructures); 1055 } 1056 1057 /** 1058 * Returns all the structures matching the group, name, and description. 1059 * 1060 * @param groupId the primary key of the structure's group 1061 * @param name the structure's name 1062 * @param description the structure's description 1063 * @return the matching structures 1064 * @throws SystemException if a system exception occurred 1065 */ 1066 @Override 1067 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure( 1068 long groupId, java.lang.String name, java.lang.String description) 1069 throws com.liferay.portal.kernel.exception.SystemException { 1070 return _ddmStructureLocalService.getStructure(groupId, name, description); 1071 } 1072 1073 /** 1074 * @deprecated As of 6.2.0, replaced by {@link #getStructures} 1075 */ 1076 @Override 1077 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries() 1078 throws com.liferay.portal.kernel.exception.SystemException { 1079 return _ddmStructureLocalService.getStructureEntries(); 1080 } 1081 1082 /** 1083 * @deprecated As of 6.2.0, replaced by {@link #getStructures(long)} 1084 */ 1085 @Override 1086 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries( 1087 long groupId) 1088 throws com.liferay.portal.kernel.exception.SystemException { 1089 return _ddmStructureLocalService.getStructureEntries(groupId); 1090 } 1091 1092 /** 1093 * @deprecated As of 6.2.0, replaced by {@link #getStructures(long, int, 1094 int)} 1095 */ 1096 @Override 1097 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries( 1098 long groupId, int start, int end) 1099 throws com.liferay.portal.kernel.exception.SystemException { 1100 return _ddmStructureLocalService.getStructureEntries(groupId, start, end); 1101 } 1102 1103 /** 1104 * Returns all the structures present in the system. 1105 * 1106 * @return the structures present in the system 1107 * @throws SystemException if a system exception occurred 1108 */ 1109 @Override 1110 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures() 1111 throws com.liferay.portal.kernel.exception.SystemException { 1112 return _ddmStructureLocalService.getStructures(); 1113 } 1114 1115 /** 1116 * Returns all the structures present in the group. 1117 * 1118 * @param groupId the primary key of the group 1119 * @return the structures present in the group 1120 * @throws SystemException if a system exception occurred 1121 */ 1122 @Override 1123 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1124 long groupId) 1125 throws com.liferay.portal.kernel.exception.SystemException { 1126 return _ddmStructureLocalService.getStructures(groupId); 1127 } 1128 1129 /** 1130 * Returns a range of all the structures belonging to the group. 1131 * 1132 * <p> 1133 * Useful when paginating results. Returns a maximum of <code>end - 1134 * start</code> instances. <code>start</code> and <code>end</code> are not 1135 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1136 * refers to the first result in the set. Setting both <code>start</code> 1137 * and <code>end</code> to {@link 1138 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1139 * result set. 1140 * </p> 1141 * 1142 * @param groupId the primary key of the group 1143 * @param start the lower bound of the range of structures to return 1144 * @param end the upper bound of the range of structures to return (not 1145 inclusive) 1146 * @return the range of matching structures 1147 * @throws SystemException if a system exception occurred 1148 */ 1149 @Override 1150 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1151 long groupId, int start, int end) 1152 throws com.liferay.portal.kernel.exception.SystemException { 1153 return _ddmStructureLocalService.getStructures(groupId, start, end); 1154 } 1155 1156 /** 1157 * Returns all the structures matching class name ID and group. 1158 * 1159 * @param groupId the primary key of the group 1160 * @param classNameId the primary key of the class name for the structure's 1161 related model 1162 * @return the matching structures 1163 * @throws SystemException if a system exception occurred 1164 */ 1165 @Override 1166 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1167 long groupId, long classNameId) 1168 throws com.liferay.portal.kernel.exception.SystemException { 1169 return _ddmStructureLocalService.getStructures(groupId, classNameId); 1170 } 1171 1172 /** 1173 * Returns a range of all the structures that match the class name ID and 1174 * group. 1175 * 1176 * <p> 1177 * Useful when paginating results. Returns a maximum of <code>end - 1178 * start</code> instances. <code>start</code> and <code>end</code> are not 1179 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1180 * refers to the first result in the set. Setting both <code>start</code> 1181 * and <code>end</code> to {@link 1182 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1183 * result set. 1184 * </p> 1185 * 1186 * @param groupId the primary key of the group 1187 * @param classNameId the primary key of the class name for the structure's 1188 related model 1189 * @param start the lower bound of the range of structures to return 1190 * @param end the upper bound of the range of structures to return (not 1191 inclusive) 1192 * @return the range of matching structures 1193 * @throws SystemException if a system exception occurred 1194 */ 1195 @Override 1196 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1197 long groupId, long classNameId, int start, int end) 1198 throws com.liferay.portal.kernel.exception.SystemException { 1199 return _ddmStructureLocalService.getStructures(groupId, classNameId, 1200 start, end); 1201 } 1202 1203 /** 1204 * Returns an ordered range of all the structures matching the class name ID 1205 * and group. 1206 * 1207 * <p> 1208 * Useful when paginating results. Returns a maximum of <code>end - 1209 * start</code> instances. <code>start</code> and <code>end</code> are not 1210 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1211 * refers to the first result in the set. Setting both <code>start</code> 1212 * and <code>end</code> to {@link 1213 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1214 * result set. 1215 * </p> 1216 * 1217 * @param groupId the primary key of the group 1218 * @param classNameId the primary key of the class name for the structure's 1219 related model 1220 * @param start the lower bound of the range of structures to return 1221 * @param end the upper bound of the range of structures to return (not 1222 inclusive) 1223 * @param orderByComparator the comparator to order the structures 1224 (optionally <code>null</code>) 1225 * @return the range of matching structures ordered by the comparator 1226 * @throws SystemException if a system exception occurred 1227 */ 1228 @Override 1229 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1230 long groupId, long classNameId, int start, int end, 1231 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1232 throws com.liferay.portal.kernel.exception.SystemException { 1233 return _ddmStructureLocalService.getStructures(groupId, classNameId, 1234 start, end, orderByComparator); 1235 } 1236 1237 @Override 1238 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1239 long groupId, java.lang.String name, java.lang.String description) 1240 throws com.liferay.portal.kernel.exception.SystemException { 1241 return _ddmStructureLocalService.getStructures(groupId, name, 1242 description); 1243 } 1244 1245 /** 1246 * Returns all the structures belonging to the groups. 1247 * 1248 * @param groupIds the primary keys of the groups 1249 * @return the structures belonging to the groups 1250 * @throws SystemException if a system exception occurred 1251 */ 1252 @Override 1253 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1254 long[] groupIds) 1255 throws com.liferay.portal.kernel.exception.SystemException { 1256 return _ddmStructureLocalService.getStructures(groupIds); 1257 } 1258 1259 /** 1260 * Returns all the structures matching the class name ID and belonging to 1261 * the groups. 1262 * 1263 * @param groupIds the primary keys of the groups 1264 * @param classNameId the primary key of the class name for the structure's 1265 related model 1266 * @return the matching structures 1267 * @throws SystemException if a system exception occurred 1268 */ 1269 @Override 1270 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1271 long[] groupIds, long classNameId) 1272 throws com.liferay.portal.kernel.exception.SystemException { 1273 return _ddmStructureLocalService.getStructures(groupIds, classNameId); 1274 } 1275 1276 /** 1277 * Returns a range of all the structures matching the class name ID and 1278 * belonging to the groups. 1279 * 1280 * <p> 1281 * Useful when paginating results. Returns a maximum of <code>end - 1282 * start</code> instances. <code>start</code> and <code>end</code> are not 1283 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1284 * refers to the first result in the set. Setting both <code>start</code> 1285 * and <code>end</code> to {@link 1286 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1287 * result set. 1288 * </p> 1289 * 1290 * @param groupIds the primary keys of the groups 1291 * @param classNameId the primary key of the class name for the structure's 1292 related model 1293 * @param start the lower bound of the range of structures to return 1294 * @param end the upper bound of the range of structures to return (not 1295 inclusive) 1296 * @return the range of matching structures 1297 * @throws SystemException if a system exception occurred 1298 */ 1299 @Override 1300 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1301 long[] groupIds, long classNameId, int start, int end) 1302 throws com.liferay.portal.kernel.exception.SystemException { 1303 return _ddmStructureLocalService.getStructures(groupIds, classNameId, 1304 start, end); 1305 } 1306 1307 /** 1308 * Returns the number of structures belonging to the group. 1309 * 1310 * @param groupId the primary key of the group 1311 * @return the number of structures belonging to the group 1312 * @throws SystemException if a system exception occurred 1313 */ 1314 @Override 1315 public int getStructuresCount(long groupId) 1316 throws com.liferay.portal.kernel.exception.SystemException { 1317 return _ddmStructureLocalService.getStructuresCount(groupId); 1318 } 1319 1320 /** 1321 * Returns the number of structures matching the class name ID and group. 1322 * 1323 * @param groupId the primary key of the group 1324 * @param classNameId the primary key of the class name for the structure's 1325 related model 1326 * @return the number of matching structures 1327 * @throws SystemException if a system exception occurred 1328 */ 1329 @Override 1330 public int getStructuresCount(long groupId, long classNameId) 1331 throws com.liferay.portal.kernel.exception.SystemException { 1332 return _ddmStructureLocalService.getStructuresCount(groupId, classNameId); 1333 } 1334 1335 /** 1336 * Returns the number of structures matching the class name ID and belonging 1337 * to the groups. 1338 * 1339 * @param groupIds the primary keys of the groups 1340 * @param classNameId the primary key of the class name for the structure's 1341 related model 1342 * @return the number of matching structures 1343 * @throws SystemException if a system exception occurred 1344 */ 1345 @Override 1346 public int getStructuresCount(long[] groupIds, long classNameId) 1347 throws com.liferay.portal.kernel.exception.SystemException { 1348 return _ddmStructureLocalService.getStructuresCount(groupIds, 1349 classNameId); 1350 } 1351 1352 /** 1353 * Returns an ordered range of all the structures matching the groups and 1354 * class name IDs, and matching the keywords in the structure names and 1355 * descriptions. 1356 * 1357 * <p> 1358 * Useful when paginating results. Returns a maximum of <code>end - 1359 * start</code> instances. <code>start</code> and <code>end</code> are not 1360 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1361 * refers to the first result in the set. Setting both <code>start</code> 1362 * and <code>end</code> to {@link 1363 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1364 * result set. 1365 * </p> 1366 * 1367 * @param companyId the primary key of the structure's company 1368 * @param groupIds the primary keys of the groups 1369 * @param classNameIds the primary keys of the class names of the models 1370 the structures are related to 1371 * @param keywords the keywords (space separated), which may occur in the 1372 structure's name or description (optionally <code>null</code>) 1373 * @param start the lower bound of the range of structures to return 1374 * @param end the upper bound of the range of structures to return (not 1375 inclusive) 1376 * @param orderByComparator the comparator to order the structures 1377 (optionally <code>null</code>) 1378 * @return the range of matching structures ordered by the comparator 1379 * @throws SystemException if a system exception occurred 1380 */ 1381 @Override 1382 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search( 1383 long companyId, long[] groupIds, long[] classNameIds, 1384 java.lang.String keywords, int start, int end, 1385 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1386 throws com.liferay.portal.kernel.exception.SystemException { 1387 return _ddmStructureLocalService.search(companyId, groupIds, 1388 classNameIds, keywords, start, end, orderByComparator); 1389 } 1390 1391 /** 1392 * Returns an ordered range of all the structures matching the groups, class 1393 * name IDs, name keyword, description keyword, storage type, and type. 1394 * 1395 * <p> 1396 * Useful when paginating results. Returns a maximum of <code>end - 1397 * start</code> instances. <code>start</code> and <code>end</code> are not 1398 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1399 * refers to the first result in the set. Setting both <code>start</code> 1400 * and <code>end</code> to {@link 1401 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1402 * result set. 1403 * </p> 1404 * 1405 * @param companyId the primary key of the structure's company 1406 * @param groupIds the primary keys of the groups 1407 * @param classNameIds the primary keys of the class names of the models 1408 the structures are related to 1409 * @param name the name keywords 1410 * @param description the description keywords 1411 * @param storageType the structure's storage type. It can be "xml" or 1412 "expando". For more information, see {@link 1413 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 1414 * @param type the structure's type. For more information, see {@link 1415 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1416 * @param andOperator whether every field must match its keywords, or just 1417 one field 1418 * @param start the lower bound of the range of structures to return 1419 * @param end the upper bound of the range of structures to return (not 1420 inclusive) 1421 * @param orderByComparator the comparator to order the structures 1422 (optionally <code>null</code>) 1423 * @return the range of matching structures ordered by the comparator 1424 * @throws SystemException if a system exception occurred 1425 */ 1426 @Override 1427 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search( 1428 long companyId, long[] groupIds, long[] classNameIds, 1429 java.lang.String name, java.lang.String description, 1430 java.lang.String storageType, int type, boolean andOperator, int start, 1431 int end, 1432 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1433 throws com.liferay.portal.kernel.exception.SystemException { 1434 return _ddmStructureLocalService.search(companyId, groupIds, 1435 classNameIds, name, description, storageType, type, andOperator, 1436 start, end, orderByComparator); 1437 } 1438 1439 /** 1440 * Returns the number of structures matching the groups and class name IDs, 1441 * and matching the keywords in the structure names and descriptions. 1442 * 1443 * @param companyId the primary key of the structure's company 1444 * @param groupIds the primary keys of the groups 1445 * @param classNameIds the primary keys of the class names of the models 1446 the structures are related to 1447 * @param keywords the keywords (space separated), which may occur in the 1448 structure's name or description (optionally <code>null</code>) 1449 * @return the number of matching structures 1450 * @throws SystemException if a system exception occurred 1451 */ 1452 @Override 1453 public int searchCount(long companyId, long[] groupIds, 1454 long[] classNameIds, java.lang.String keywords) 1455 throws com.liferay.portal.kernel.exception.SystemException { 1456 return _ddmStructureLocalService.searchCount(companyId, groupIds, 1457 classNameIds, keywords); 1458 } 1459 1460 /** 1461 * Returns the number of structures matching the groups, class name IDs, 1462 * name keyword, description keyword, storage type, and type 1463 * 1464 * @param companyId the primary key of the structure's company 1465 * @param groupIds the primary keys of the groups 1466 * @param classNameIds the primary keys of the class names of the models 1467 the structure's are related to 1468 * @param name the name keywords 1469 * @param description the description keywords 1470 * @param storageType the structure's storage type. It can be "xml" or 1471 "expando". For more information, see {@link 1472 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 1473 * @param type the structure's type. For more information, see {@link 1474 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1475 * @param andOperator whether every field must match its keywords, or just 1476 one field 1477 * @return the number of matching structures 1478 * @throws SystemException if a system exception occurred 1479 */ 1480 @Override 1481 public int searchCount(long companyId, long[] groupIds, 1482 long[] classNameIds, java.lang.String name, 1483 java.lang.String description, java.lang.String storageType, int type, 1484 boolean andOperator) 1485 throws com.liferay.portal.kernel.exception.SystemException { 1486 return _ddmStructureLocalService.searchCount(companyId, groupIds, 1487 classNameIds, name, description, storageType, type, andOperator); 1488 } 1489 1490 /** 1491 * Updates the structure matching the class name ID, structure key, and 1492 * group, replacing its old parent structure, name map, description map, and 1493 * XSD with new ones. 1494 * 1495 * @param groupId the primary key of the group 1496 * @param parentStructureId the primary key of the new parent structure 1497 * @param classNameId the primary key of the class name for the structure's 1498 related model 1499 * @param structureKey the unique string identifying the structure 1500 * @param nameMap the structure's new locales and localized names 1501 * @param descriptionMap the structure's new locales and localized 1502 description 1503 * @param xsd the structure's new XML schema definition 1504 * @param serviceContext the service context to be applied. Can set the 1505 structure's modification date. 1506 * @return the updated structure 1507 * @throws PortalException if a matching structure could not be found, if 1508 the XSD was not well-formed, or if a portal exception occurred 1509 * @throws SystemException if a system exception occurred 1510 */ 1511 @Override 1512 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1513 long groupId, long parentStructureId, long classNameId, 1514 java.lang.String structureKey, 1515 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1516 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1517 java.lang.String xsd, 1518 com.liferay.portal.service.ServiceContext serviceContext) 1519 throws com.liferay.portal.kernel.exception.PortalException, 1520 com.liferay.portal.kernel.exception.SystemException { 1521 return _ddmStructureLocalService.updateStructure(groupId, 1522 parentStructureId, classNameId, structureKey, nameMap, 1523 descriptionMap, xsd, serviceContext); 1524 } 1525 1526 /** 1527 * Updates the structure matching the structure ID, replacing its old parent 1528 * structure, name map, description map, and XSD with new ones. 1529 * 1530 * @param structureId the primary key of the structure 1531 * @param parentStructureId the primary key of the new parent structure 1532 * @param nameMap the structure's new locales and localized names 1533 * @param descriptionMap the structure's new locales and localized 1534 descriptions 1535 * @param xsd the structure's new XML schema definition 1536 * @param serviceContext the service context to be applied. Can set the 1537 structure's modification date. 1538 * @return the updated structure 1539 * @throws PortalException if a matching structure could not be found, if 1540 the XSD was not well-formed, or if a portal exception occurred 1541 * @throws SystemException if a system exception occurred 1542 */ 1543 @Override 1544 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1545 long structureId, long parentStructureId, 1546 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1547 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1548 java.lang.String xsd, 1549 com.liferay.portal.service.ServiceContext serviceContext) 1550 throws com.liferay.portal.kernel.exception.PortalException, 1551 com.liferay.portal.kernel.exception.SystemException { 1552 return _ddmStructureLocalService.updateStructure(structureId, 1553 parentStructureId, nameMap, descriptionMap, xsd, serviceContext); 1554 } 1555 1556 /** 1557 * Updates the structure matching the structure ID, replacing its XSD with a 1558 * new one. 1559 * 1560 * @param structureId the primary key of the structure 1561 * @param xsd the structure's new XML schema definition 1562 * @param serviceContext the service context to be applied. Can set the 1563 structure's modification date. 1564 * @return the updated structure 1565 * @throws PortalException if a matching structure could not be found, if 1566 the XSD was not well-formed, or if a portal exception occurred 1567 * @throws SystemException if a system exception occurred 1568 */ 1569 @Override 1570 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateXSD( 1571 long structureId, java.lang.String xsd, 1572 com.liferay.portal.service.ServiceContext serviceContext) 1573 throws com.liferay.portal.kernel.exception.PortalException, 1574 com.liferay.portal.kernel.exception.SystemException { 1575 return _ddmStructureLocalService.updateXSD(structureId, xsd, 1576 serviceContext); 1577 } 1578 1579 /** 1580 * Updates the structure matching the structure ID, replacing the metadata 1581 * entry of the named field. 1582 * 1583 * @param structureId the primary key of the structure 1584 * @param fieldName the name of the field whose metadata to update 1585 * @param metadataEntryName the metadata entry's name 1586 * @param metadataEntryValue the metadata entry's value 1587 * @param serviceContext the service context to be applied. Can set the 1588 structure's modification date. 1589 * @throws PortalException if a matching structure could not be found, if 1590 the XSD was not well-formed, or if a portal exception occurred 1591 * @throws SystemException if a system exception occurred 1592 */ 1593 @Override 1594 public void updateXSDFieldMetadata(long structureId, 1595 java.lang.String fieldName, java.lang.String metadataEntryName, 1596 java.lang.String metadataEntryValue, 1597 com.liferay.portal.service.ServiceContext serviceContext) 1598 throws com.liferay.portal.kernel.exception.PortalException, 1599 com.liferay.portal.kernel.exception.SystemException { 1600 _ddmStructureLocalService.updateXSDFieldMetadata(structureId, 1601 fieldName, metadataEntryName, metadataEntryValue, serviceContext); 1602 } 1603 1604 /** 1605 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 1606 */ 1607 public DDMStructureLocalService getWrappedDDMStructureLocalService() { 1608 return _ddmStructureLocalService; 1609 } 1610 1611 /** 1612 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 1613 */ 1614 public void setWrappedDDMStructureLocalService( 1615 DDMStructureLocalService ddmStructureLocalService) { 1616 _ddmStructureLocalService = ddmStructureLocalService; 1617 } 1618 1619 @Override 1620 public DDMStructureLocalService getWrappedService() { 1621 return _ddmStructureLocalService; 1622 } 1623 1624 @Override 1625 public void setWrappedService( 1626 DDMStructureLocalService ddmStructureLocalService) { 1627 _ddmStructureLocalService = ddmStructureLocalService; 1628 } 1629 1630 private DDMStructureLocalService _ddmStructureLocalService; 1631 }