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 @Override 806 public void deleteStructures(long groupId, long classNameId) 807 throws com.liferay.portal.kernel.exception.PortalException, 808 com.liferay.portal.kernel.exception.SystemException { 809 _ddmStructureLocalService.deleteStructures(groupId, classNameId); 810 } 811 812 /** 813 * Returns the structure with the ID. 814 * 815 * @param structureId the primary key of the structure 816 * @return the structure with the structure ID, or <code>null</code> if a 817 matching structure could not be found 818 * @throws SystemException if a system exception occurred 819 */ 820 @Override 821 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 822 long structureId) 823 throws com.liferay.portal.kernel.exception.SystemException { 824 return _ddmStructureLocalService.fetchStructure(structureId); 825 } 826 827 /** 828 * Returns the structure matching the class name ID, structure key, and 829 * group. 830 * 831 * @param groupId the primary key of the group 832 * @param classNameId the primary key of the class name for the structure's 833 related model 834 * @param structureKey the unique string identifying the structure 835 * @return the matching structure, or <code>null</code> if a matching 836 structure could not be found 837 * @throws SystemException if a system exception occurred 838 */ 839 @Override 840 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 841 long groupId, long classNameId, java.lang.String structureKey) 842 throws com.liferay.portal.kernel.exception.SystemException { 843 return _ddmStructureLocalService.fetchStructure(groupId, classNameId, 844 structureKey); 845 } 846 847 /** 848 * Returns the structure matching the class name ID, structure key, and 849 * group, optionally in the global scope. 850 * 851 * <p> 852 * This method first searches in the group. If the structure is still not 853 * found and <code>includeGlobalStructures</code> is set to 854 * <code>true</code>, this method searches the global group. 855 * </p> 856 * 857 * @param groupId the primary key of the group 858 * @param classNameId the primary key of the class name for the structure's 859 related model 860 * @param structureKey the unique string identifying the structure 861 * @param includeGlobalStructures whether to include the global scope in 862 the search 863 * @return the matching structure, or <code>null</code> if a matching 864 structure could not be found 865 * @throws PortalException if a portal exception occurred 866 * @throws SystemException if a system exception occurred 867 */ 868 @Override 869 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 870 long groupId, long classNameId, java.lang.String structureKey, 871 boolean includeGlobalStructures) 872 throws com.liferay.portal.kernel.exception.PortalException, 873 com.liferay.portal.kernel.exception.SystemException { 874 return _ddmStructureLocalService.fetchStructure(groupId, classNameId, 875 structureKey, includeGlobalStructures); 876 } 877 878 /** 879 * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long, 880 long)} 881 */ 882 @Override 883 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 884 long classNameId) 885 throws com.liferay.portal.kernel.exception.SystemException { 886 return _ddmStructureLocalService.getClassStructures(classNameId); 887 } 888 889 /** 890 * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long, 891 long, int, int)} 892 */ 893 @Override 894 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 895 long classNameId, int start, int end) 896 throws com.liferay.portal.kernel.exception.SystemException { 897 return _ddmStructureLocalService.getClassStructures(classNameId, start, 898 end); 899 } 900 901 /** 902 * Returns all the structures matching the class name ID. 903 * 904 * @param companyId the primary key of the structure's company 905 * @param classNameId the primary key of the class name for the structure's 906 related model 907 * @return the structures matching the class name ID 908 * @throws SystemException if a system exception occurred 909 */ 910 @Override 911 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 912 long companyId, long classNameId) 913 throws com.liferay.portal.kernel.exception.SystemException { 914 return _ddmStructureLocalService.getClassStructures(companyId, 915 classNameId); 916 } 917 918 /** 919 * Returns a range of all the structures matching the class name ID. 920 * 921 * <p> 922 * Useful when paginating results. Returns a maximum of <code>end - 923 * start</code> instances. <code>start</code> and <code>end</code> are not 924 * primary keys, they are indexes in the result set. Thus, <code>0</code> 925 * refers to the first result in the set. Setting both <code>start</code> 926 * and <code>end</code> to {@link 927 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 928 * result set. 929 * </p> 930 * 931 * @param companyId the primary key of the structure's company 932 * @param classNameId the primary key of the class name for the structure's 933 related model 934 * @param start the lower bound of the range of structures to return 935 * @param end the upper bound of the range of structures to return (not 936 inclusive) 937 * @return the range of matching structures 938 * @throws SystemException if a system exception occurred 939 */ 940 @Override 941 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 942 long companyId, long classNameId, int start, int end) 943 throws com.liferay.portal.kernel.exception.SystemException { 944 return _ddmStructureLocalService.getClassStructures(companyId, 945 classNameId, start, end); 946 } 947 948 /** 949 * Returns all the structures matching the class name ID ordered by the 950 * comparator. 951 * 952 * @param companyId the primary key of the structure's company 953 * @param classNameId the primary key of the class name for the structure's 954 related model 955 * @param orderByComparator the comparator to order the structures 956 (optionally <code>null</code>) 957 * @return the matching structures ordered by the comparator 958 * @throws SystemException if a system exception occurred 959 */ 960 @Override 961 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 962 long companyId, long classNameId, 963 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 964 throws com.liferay.portal.kernel.exception.SystemException { 965 return _ddmStructureLocalService.getClassStructures(companyId, 966 classNameId, orderByComparator); 967 } 968 969 /** 970 * @deprecated As of 6.2.0, replaced by {@link #getClassStructures(long, 971 long, OrderByComparator)} 972 */ 973 @Override 974 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 975 long classNameId, 976 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 977 throws com.liferay.portal.kernel.exception.SystemException { 978 return _ddmStructureLocalService.getClassStructures(classNameId, 979 orderByComparator); 980 } 981 982 /** 983 * Returns all the structures for the document library file entry type. 984 * 985 * @param dlFileEntryTypeId the primary key of the document library file 986 entry type 987 * @return the structures for the document library file entry type 988 * @throws SystemException if a system exception occurred 989 */ 990 @Override 991 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures( 992 long dlFileEntryTypeId) 993 throws com.liferay.portal.kernel.exception.SystemException { 994 return _ddmStructureLocalService.getDLFileEntryTypeStructures(dlFileEntryTypeId); 995 } 996 997 /** 998 * Returns the structure with the ID. 999 * 1000 * @param structureId the primary key of the structure 1001 * @return the structure with the ID 1002 * @throws PortalException if a structure with the ID could not be found 1003 * @throws SystemException if a system exception occurred 1004 */ 1005 @Override 1006 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 1007 long structureId) 1008 throws com.liferay.portal.kernel.exception.PortalException, 1009 com.liferay.portal.kernel.exception.SystemException { 1010 return _ddmStructureLocalService.getStructure(structureId); 1011 } 1012 1013 /** 1014 * Returns the structure matching the class name ID, structure key, and 1015 * group. 1016 * 1017 * @param groupId the primary key of the structure's group 1018 * @param classNameId the primary key of the class name for the structure's 1019 related model 1020 * @param structureKey the unique string identifying the structure 1021 * @return the matching structure 1022 * @throws PortalException if a matching structure could not be found 1023 * @throws SystemException if a system exception occurred 1024 */ 1025 @Override 1026 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 1027 long groupId, long classNameId, java.lang.String structureKey) 1028 throws com.liferay.portal.kernel.exception.PortalException, 1029 com.liferay.portal.kernel.exception.SystemException { 1030 return _ddmStructureLocalService.getStructure(groupId, classNameId, 1031 structureKey); 1032 } 1033 1034 /** 1035 * Returns the structure matching the class name ID, structure key, and 1036 * group, optionally in the global scope. 1037 * 1038 * <p> 1039 * This method first searches in the group. If the structure is still not 1040 * found and <code>includeGlobalStructures</code> is set to 1041 * <code>true</code>, this method searches the global group. 1042 * </p> 1043 * 1044 * @param groupId the primary key of the structure's group 1045 * @param classNameId the primary key of the class name for the structure's 1046 related model 1047 * @param structureKey the unique string identifying the structure 1048 * @param includeGlobalStructures whether to include the global scope in 1049 the search 1050 * @return the matching structure 1051 * @throws PortalException if a matching structure could not be found 1052 * @throws SystemException if a system exception occurred 1053 */ 1054 @Override 1055 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 1056 long groupId, long classNameId, java.lang.String structureKey, 1057 boolean includeGlobalStructures) 1058 throws com.liferay.portal.kernel.exception.PortalException, 1059 com.liferay.portal.kernel.exception.SystemException { 1060 return _ddmStructureLocalService.getStructure(groupId, classNameId, 1061 structureKey, includeGlobalStructures); 1062 } 1063 1064 /** 1065 * Returns all the structures matching the group, name, and description. 1066 * 1067 * @param groupId the primary key of the structure's group 1068 * @param name the structure's name 1069 * @param description the structure's description 1070 * @return the matching structures 1071 * @throws SystemException if a system exception occurred 1072 */ 1073 @Override 1074 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure( 1075 long groupId, java.lang.String name, java.lang.String description) 1076 throws com.liferay.portal.kernel.exception.SystemException { 1077 return _ddmStructureLocalService.getStructure(groupId, name, description); 1078 } 1079 1080 /** 1081 * @deprecated As of 6.2.0, replaced by {@link #getStructures} 1082 */ 1083 @Override 1084 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries() 1085 throws com.liferay.portal.kernel.exception.SystemException { 1086 return _ddmStructureLocalService.getStructureEntries(); 1087 } 1088 1089 /** 1090 * @deprecated As of 6.2.0, replaced by {@link #getStructures(long)} 1091 */ 1092 @Override 1093 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries( 1094 long groupId) 1095 throws com.liferay.portal.kernel.exception.SystemException { 1096 return _ddmStructureLocalService.getStructureEntries(groupId); 1097 } 1098 1099 /** 1100 * @deprecated As of 6.2.0, replaced by {@link #getStructures(long, int, 1101 int)} 1102 */ 1103 @Override 1104 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries( 1105 long groupId, int start, int end) 1106 throws com.liferay.portal.kernel.exception.SystemException { 1107 return _ddmStructureLocalService.getStructureEntries(groupId, start, end); 1108 } 1109 1110 /** 1111 * Returns all the structures present in the system. 1112 * 1113 * @return the structures present in the system 1114 * @throws SystemException if a system exception occurred 1115 */ 1116 @Override 1117 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures() 1118 throws com.liferay.portal.kernel.exception.SystemException { 1119 return _ddmStructureLocalService.getStructures(); 1120 } 1121 1122 /** 1123 * Returns all the structures present in the group. 1124 * 1125 * @param groupId the primary key of the group 1126 * @return the structures present in the group 1127 * @throws SystemException if a system exception occurred 1128 */ 1129 @Override 1130 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1131 long groupId) 1132 throws com.liferay.portal.kernel.exception.SystemException { 1133 return _ddmStructureLocalService.getStructures(groupId); 1134 } 1135 1136 /** 1137 * Returns a range of all the structures belonging to the group. 1138 * 1139 * <p> 1140 * Useful when paginating results. Returns a maximum of <code>end - 1141 * start</code> instances. <code>start</code> and <code>end</code> are not 1142 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1143 * refers to the first result in the set. Setting both <code>start</code> 1144 * and <code>end</code> to {@link 1145 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1146 * result set. 1147 * </p> 1148 * 1149 * @param groupId the primary key of the group 1150 * @param start the lower bound of the range of structures to return 1151 * @param end the upper bound of the range of structures to return (not 1152 inclusive) 1153 * @return the range of matching structures 1154 * @throws SystemException if a system exception occurred 1155 */ 1156 @Override 1157 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1158 long groupId, int start, int end) 1159 throws com.liferay.portal.kernel.exception.SystemException { 1160 return _ddmStructureLocalService.getStructures(groupId, start, end); 1161 } 1162 1163 /** 1164 * Returns all the structures matching class name ID and group. 1165 * 1166 * @param groupId the primary key of the group 1167 * @param classNameId the primary key of the class name for the structure's 1168 related model 1169 * @return the matching structures 1170 * @throws SystemException if a system exception occurred 1171 */ 1172 @Override 1173 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1174 long groupId, long classNameId) 1175 throws com.liferay.portal.kernel.exception.SystemException { 1176 return _ddmStructureLocalService.getStructures(groupId, classNameId); 1177 } 1178 1179 /** 1180 * Returns a range of all the structures that match the class name ID and 1181 * group. 1182 * 1183 * <p> 1184 * Useful when paginating results. Returns a maximum of <code>end - 1185 * start</code> instances. <code>start</code> and <code>end</code> are not 1186 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1187 * refers to the first result in the set. Setting both <code>start</code> 1188 * and <code>end</code> to {@link 1189 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1190 * result set. 1191 * </p> 1192 * 1193 * @param groupId the primary key of the group 1194 * @param classNameId the primary key of the class name for the structure's 1195 related model 1196 * @param start the lower bound of the range of structures to return 1197 * @param end the upper bound of the range of structures to return (not 1198 inclusive) 1199 * @return the range of matching structures 1200 * @throws SystemException if a system exception occurred 1201 */ 1202 @Override 1203 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1204 long groupId, long classNameId, int start, int end) 1205 throws com.liferay.portal.kernel.exception.SystemException { 1206 return _ddmStructureLocalService.getStructures(groupId, classNameId, 1207 start, end); 1208 } 1209 1210 /** 1211 * Returns an ordered range of all the structures matching the class name ID 1212 * and group. 1213 * 1214 * <p> 1215 * Useful when paginating results. Returns a maximum of <code>end - 1216 * start</code> instances. <code>start</code> and <code>end</code> are not 1217 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1218 * refers to the first result in the set. Setting both <code>start</code> 1219 * and <code>end</code> to {@link 1220 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1221 * result set. 1222 * </p> 1223 * 1224 * @param groupId the primary key of the group 1225 * @param classNameId the primary key of the class name for the structure's 1226 related model 1227 * @param start the lower bound of the range of structures to return 1228 * @param end the upper bound of the range of structures to return (not 1229 inclusive) 1230 * @param orderByComparator the comparator to order the structures 1231 (optionally <code>null</code>) 1232 * @return the range of matching structures ordered by the comparator 1233 * @throws SystemException if a system exception occurred 1234 */ 1235 @Override 1236 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1237 long groupId, long classNameId, int start, int end, 1238 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1239 throws com.liferay.portal.kernel.exception.SystemException { 1240 return _ddmStructureLocalService.getStructures(groupId, classNameId, 1241 start, end, orderByComparator); 1242 } 1243 1244 @Override 1245 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1246 long groupId, java.lang.String name, java.lang.String description) 1247 throws com.liferay.portal.kernel.exception.SystemException { 1248 return _ddmStructureLocalService.getStructures(groupId, name, 1249 description); 1250 } 1251 1252 /** 1253 * Returns all the structures belonging to the groups. 1254 * 1255 * @param groupIds the primary keys of the groups 1256 * @return the structures belonging to the groups 1257 * @throws SystemException if a system exception occurred 1258 */ 1259 @Override 1260 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1261 long[] groupIds) 1262 throws com.liferay.portal.kernel.exception.SystemException { 1263 return _ddmStructureLocalService.getStructures(groupIds); 1264 } 1265 1266 /** 1267 * Returns all the structures matching the class name ID and belonging to 1268 * the groups. 1269 * 1270 * @param groupIds the primary keys of the groups 1271 * @param classNameId the primary key of the class name for the structure's 1272 related model 1273 * @return the matching structures 1274 * @throws SystemException if a system exception occurred 1275 */ 1276 @Override 1277 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1278 long[] groupIds, long classNameId) 1279 throws com.liferay.portal.kernel.exception.SystemException { 1280 return _ddmStructureLocalService.getStructures(groupIds, classNameId); 1281 } 1282 1283 /** 1284 * Returns a range of all the structures matching the class name ID and 1285 * belonging to the groups. 1286 * 1287 * <p> 1288 * Useful when paginating results. Returns a maximum of <code>end - 1289 * start</code> instances. <code>start</code> and <code>end</code> are not 1290 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1291 * refers to the first result in the set. Setting both <code>start</code> 1292 * and <code>end</code> to {@link 1293 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1294 * result set. 1295 * </p> 1296 * 1297 * @param groupIds the primary keys of the groups 1298 * @param classNameId the primary key of the class name for the structure's 1299 related model 1300 * @param start the lower bound of the range of structures to return 1301 * @param end the upper bound of the range of structures to return (not 1302 inclusive) 1303 * @return the range of matching structures 1304 * @throws SystemException if a system exception occurred 1305 */ 1306 @Override 1307 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 1308 long[] groupIds, long classNameId, int start, int end) 1309 throws com.liferay.portal.kernel.exception.SystemException { 1310 return _ddmStructureLocalService.getStructures(groupIds, classNameId, 1311 start, end); 1312 } 1313 1314 /** 1315 * Returns the number of structures belonging to the group. 1316 * 1317 * @param groupId the primary key of the group 1318 * @return the number of structures belonging to the group 1319 * @throws SystemException if a system exception occurred 1320 */ 1321 @Override 1322 public int getStructuresCount(long groupId) 1323 throws com.liferay.portal.kernel.exception.SystemException { 1324 return _ddmStructureLocalService.getStructuresCount(groupId); 1325 } 1326 1327 /** 1328 * Returns the number of structures matching the class name ID and group. 1329 * 1330 * @param groupId the primary key of the group 1331 * @param classNameId the primary key of the class name for the structure's 1332 related model 1333 * @return the number of matching structures 1334 * @throws SystemException if a system exception occurred 1335 */ 1336 @Override 1337 public int getStructuresCount(long groupId, long classNameId) 1338 throws com.liferay.portal.kernel.exception.SystemException { 1339 return _ddmStructureLocalService.getStructuresCount(groupId, classNameId); 1340 } 1341 1342 /** 1343 * Returns the number of structures matching the class name ID and belonging 1344 * to the groups. 1345 * 1346 * @param groupIds the primary keys of the groups 1347 * @param classNameId the primary key of the class name for the structure's 1348 related model 1349 * @return the number of matching structures 1350 * @throws SystemException if a system exception occurred 1351 */ 1352 @Override 1353 public int getStructuresCount(long[] groupIds, long classNameId) 1354 throws com.liferay.portal.kernel.exception.SystemException { 1355 return _ddmStructureLocalService.getStructuresCount(groupIds, 1356 classNameId); 1357 } 1358 1359 /** 1360 * Returns an ordered range of all the structures matching the groups and 1361 * class name IDs, and matching the keywords in the structure names and 1362 * descriptions. 1363 * 1364 * <p> 1365 * Useful when paginating results. Returns a maximum of <code>end - 1366 * start</code> instances. <code>start</code> and <code>end</code> are not 1367 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1368 * refers to the first result in the set. Setting both <code>start</code> 1369 * and <code>end</code> to {@link 1370 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1371 * result set. 1372 * </p> 1373 * 1374 * @param companyId the primary key of the structure's company 1375 * @param groupIds the primary keys of the groups 1376 * @param classNameIds the primary keys of the class names of the models 1377 the structures are related to 1378 * @param keywords the keywords (space separated), which may occur in the 1379 structure's name or description (optionally <code>null</code>) 1380 * @param start the lower bound of the range of structures to return 1381 * @param end the upper bound of the range of structures to return (not 1382 inclusive) 1383 * @param orderByComparator the comparator to order the structures 1384 (optionally <code>null</code>) 1385 * @return the range of matching structures ordered by the comparator 1386 * @throws SystemException if a system exception occurred 1387 */ 1388 @Override 1389 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search( 1390 long companyId, long[] groupIds, long[] classNameIds, 1391 java.lang.String keywords, int start, int end, 1392 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1393 throws com.liferay.portal.kernel.exception.SystemException { 1394 return _ddmStructureLocalService.search(companyId, groupIds, 1395 classNameIds, keywords, start, end, orderByComparator); 1396 } 1397 1398 /** 1399 * Returns an ordered range of all the structures matching the groups, class 1400 * name IDs, name keyword, description keyword, storage type, and type. 1401 * 1402 * <p> 1403 * Useful when paginating results. Returns a maximum of <code>end - 1404 * start</code> instances. <code>start</code> and <code>end</code> are not 1405 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1406 * refers to the first result in the set. Setting both <code>start</code> 1407 * and <code>end</code> to {@link 1408 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1409 * result set. 1410 * </p> 1411 * 1412 * @param companyId the primary key of the structure's company 1413 * @param groupIds the primary keys of the groups 1414 * @param classNameIds the primary keys of the class names of the models 1415 the structures are related to 1416 * @param name the name keywords 1417 * @param description the description keywords 1418 * @param storageType the structure's storage type. It can be "xml" or 1419 "expando". For more information, see {@link 1420 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 1421 * @param type the structure's type. For more information, see {@link 1422 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1423 * @param andOperator whether every field must match its keywords, or just 1424 one field 1425 * @param start the lower bound of the range of structures to return 1426 * @param end the upper bound of the range of structures to return (not 1427 inclusive) 1428 * @param orderByComparator the comparator to order the structures 1429 (optionally <code>null</code>) 1430 * @return the range of matching structures ordered by the comparator 1431 * @throws SystemException if a system exception occurred 1432 */ 1433 @Override 1434 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search( 1435 long companyId, long[] groupIds, long[] classNameIds, 1436 java.lang.String name, java.lang.String description, 1437 java.lang.String storageType, int type, boolean andOperator, int start, 1438 int end, 1439 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1440 throws com.liferay.portal.kernel.exception.SystemException { 1441 return _ddmStructureLocalService.search(companyId, groupIds, 1442 classNameIds, name, description, storageType, type, andOperator, 1443 start, end, orderByComparator); 1444 } 1445 1446 /** 1447 * Returns the number of structures matching the groups and class name IDs, 1448 * and matching the keywords in the structure names and descriptions. 1449 * 1450 * @param companyId the primary key of the structure's company 1451 * @param groupIds the primary keys of the groups 1452 * @param classNameIds the primary keys of the class names of the models 1453 the structures are related to 1454 * @param keywords the keywords (space separated), which may occur in the 1455 structure's name or description (optionally <code>null</code>) 1456 * @return the number of matching structures 1457 * @throws SystemException if a system exception occurred 1458 */ 1459 @Override 1460 public int searchCount(long companyId, long[] groupIds, 1461 long[] classNameIds, java.lang.String keywords) 1462 throws com.liferay.portal.kernel.exception.SystemException { 1463 return _ddmStructureLocalService.searchCount(companyId, groupIds, 1464 classNameIds, keywords); 1465 } 1466 1467 /** 1468 * Returns the number of structures matching the groups, class name IDs, 1469 * name keyword, description keyword, storage type, and type 1470 * 1471 * @param companyId the primary key of the structure's company 1472 * @param groupIds the primary keys of the groups 1473 * @param classNameIds the primary keys of the class names of the models 1474 the structure's are related to 1475 * @param name the name keywords 1476 * @param description the description keywords 1477 * @param storageType the structure's storage type. It can be "xml" or 1478 "expando". For more information, see {@link 1479 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 1480 * @param type the structure's type. For more information, see {@link 1481 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1482 * @param andOperator whether every field must match its keywords, or just 1483 one field 1484 * @return the number of matching structures 1485 * @throws SystemException if a system exception occurred 1486 */ 1487 @Override 1488 public int searchCount(long companyId, long[] groupIds, 1489 long[] classNameIds, java.lang.String name, 1490 java.lang.String description, java.lang.String storageType, int type, 1491 boolean andOperator) 1492 throws com.liferay.portal.kernel.exception.SystemException { 1493 return _ddmStructureLocalService.searchCount(companyId, groupIds, 1494 classNameIds, name, description, storageType, type, andOperator); 1495 } 1496 1497 /** 1498 * Updates the structure matching the class name ID, structure key, and 1499 * group, replacing its old parent structure, name map, description map, and 1500 * XSD with new ones. 1501 * 1502 * @param groupId the primary key of the group 1503 * @param parentStructureId the primary key of the new parent structure 1504 * @param classNameId the primary key of the class name for the structure's 1505 related model 1506 * @param structureKey the unique string identifying the structure 1507 * @param nameMap the structure's new locales and localized names 1508 * @param descriptionMap the structure's new locales and localized 1509 description 1510 * @param xsd the structure's new XML schema definition 1511 * @param serviceContext the service context to be applied. Can set the 1512 structure's modification date. 1513 * @return the updated structure 1514 * @throws PortalException if a matching structure could not be found, if 1515 the XSD was not well-formed, or if a portal exception occurred 1516 * @throws SystemException if a system exception occurred 1517 */ 1518 @Override 1519 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1520 long groupId, long parentStructureId, long classNameId, 1521 java.lang.String structureKey, 1522 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1523 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1524 java.lang.String xsd, 1525 com.liferay.portal.service.ServiceContext serviceContext) 1526 throws com.liferay.portal.kernel.exception.PortalException, 1527 com.liferay.portal.kernel.exception.SystemException { 1528 return _ddmStructureLocalService.updateStructure(groupId, 1529 parentStructureId, classNameId, structureKey, nameMap, 1530 descriptionMap, xsd, serviceContext); 1531 } 1532 1533 /** 1534 * Updates the structure matching the structure ID, replacing its old parent 1535 * structure, name map, description map, and XSD with new ones. 1536 * 1537 * @param structureId the primary key of the structure 1538 * @param parentStructureId the primary key of the new parent structure 1539 * @param nameMap the structure's new locales and localized names 1540 * @param descriptionMap the structure's new locales and localized 1541 descriptions 1542 * @param xsd the structure's new XML schema definition 1543 * @param serviceContext the service context to be applied. Can set the 1544 structure's modification date. 1545 * @return the updated structure 1546 * @throws PortalException if a matching structure could not be found, if 1547 the XSD was not well-formed, or if a portal exception occurred 1548 * @throws SystemException if a system exception occurred 1549 */ 1550 @Override 1551 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1552 long structureId, long parentStructureId, 1553 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1554 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1555 java.lang.String xsd, 1556 com.liferay.portal.service.ServiceContext serviceContext) 1557 throws com.liferay.portal.kernel.exception.PortalException, 1558 com.liferay.portal.kernel.exception.SystemException { 1559 return _ddmStructureLocalService.updateStructure(structureId, 1560 parentStructureId, nameMap, descriptionMap, xsd, serviceContext); 1561 } 1562 1563 /** 1564 * Updates the structure matching the structure ID, replacing its XSD with a 1565 * new one. 1566 * 1567 * @param structureId the primary key of the structure 1568 * @param xsd the structure's new XML schema definition 1569 * @param serviceContext the service context to be applied. Can set the 1570 structure's modification date. 1571 * @return the updated structure 1572 * @throws PortalException if a matching structure could not be found, if 1573 the XSD was not well-formed, or if a portal exception occurred 1574 * @throws SystemException if a system exception occurred 1575 */ 1576 @Override 1577 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateXSD( 1578 long structureId, java.lang.String xsd, 1579 com.liferay.portal.service.ServiceContext serviceContext) 1580 throws com.liferay.portal.kernel.exception.PortalException, 1581 com.liferay.portal.kernel.exception.SystemException { 1582 return _ddmStructureLocalService.updateXSD(structureId, xsd, 1583 serviceContext); 1584 } 1585 1586 /** 1587 * Updates the structure matching the structure ID, replacing the metadata 1588 * entry of the named field. 1589 * 1590 * @param structureId the primary key of the structure 1591 * @param fieldName the name of the field whose metadata to update 1592 * @param metadataEntryName the metadata entry's name 1593 * @param metadataEntryValue the metadata entry's value 1594 * @param serviceContext the service context to be applied. Can set the 1595 structure's modification date. 1596 * @throws PortalException if a matching structure could not be found, 1597 if the XSD was not well-formed, or if a portal exception 1598 occurred 1599 * @throws SystemException if a system exception occurred 1600 * @deprecated As of 6.2.0, with no direct replacement 1601 */ 1602 @Override 1603 public void updateXSDFieldMetadata(long structureId, 1604 java.lang.String fieldName, java.lang.String metadataEntryName, 1605 java.lang.String metadataEntryValue, 1606 com.liferay.portal.service.ServiceContext serviceContext) 1607 throws com.liferay.portal.kernel.exception.PortalException, 1608 com.liferay.portal.kernel.exception.SystemException { 1609 _ddmStructureLocalService.updateXSDFieldMetadata(structureId, 1610 fieldName, metadataEntryName, metadataEntryValue, serviceContext); 1611 } 1612 1613 /** 1614 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 1615 */ 1616 public DDMStructureLocalService getWrappedDDMStructureLocalService() { 1617 return _ddmStructureLocalService; 1618 } 1619 1620 /** 1621 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 1622 */ 1623 public void setWrappedDDMStructureLocalService( 1624 DDMStructureLocalService ddmStructureLocalService) { 1625 _ddmStructureLocalService = ddmStructureLocalService; 1626 } 1627 1628 @Override 1629 public DDMStructureLocalService getWrappedService() { 1630 return _ddmStructureLocalService; 1631 } 1632 1633 @Override 1634 public void setWrappedService( 1635 DDMStructureLocalService ddmStructureLocalService) { 1636 _ddmStructureLocalService = ddmStructureLocalService; 1637 } 1638 1639 private DDMStructureLocalService _ddmStructureLocalService; 1640 }