001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.dynamicdatamapping.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.model.SystemEventConstants; 026 import com.liferay.portal.service.BaseLocalService; 027 import com.liferay.portal.service.PersistedModelLocalService; 028 029 /** 030 * Provides the local service interface for DDMStructure. Methods of this 031 * service will not have security checks based on the propagated JAAS 032 * credentials because this service can only be accessed from within the same 033 * VM. 034 * 035 * @author Brian Wing Shun Chan 036 * @see DDMStructureLocalServiceUtil 037 * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl 038 * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl 039 * @generated 040 */ 041 @ProviderType 042 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 043 PortalException.class, SystemException.class}) 044 public interface DDMStructureLocalService extends BaseLocalService, 045 PersistedModelLocalService { 046 /* 047 * NOTE FOR DEVELOPERS: 048 * 049 * Never modify or reference this interface directly. Always use {@link DDMStructureLocalServiceUtil} to access the d d m structure local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 050 */ 051 052 /** 053 * Adds the d d m structure to the database. Also notifies the appropriate model listeners. 054 * 055 * @param ddmStructure the d d m structure 056 * @return the d d m structure that was added 057 */ 058 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 059 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addDDMStructure( 060 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure); 061 062 public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId, 063 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure); 064 065 public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId, 066 long structureId); 067 068 public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId, 069 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> DDMStructures); 070 071 public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId, 072 long[] structureIds); 073 074 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 075 long userId, long groupId, long classNameId, 076 java.util.Map<java.util.Locale, java.lang.String> nameMap, 077 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 078 com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm, 079 com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout, 080 com.liferay.portal.service.ServiceContext serviceContext) 081 throws PortalException; 082 083 /** 084 * Adds a structure referencing a default parent structure, using the portal 085 * property <code>dynamic.data.lists.storage.type</code> storage type and 086 * default structure type. 087 * 088 * @param userId the primary key of the structure's creator/owner 089 * @param groupId the primary key of the group 090 * @param classNameId the primary key of the class name for the 091 structure's related model 092 * @param nameMap the structure's locales and localized names 093 * @param descriptionMap the structure's locales and localized 094 descriptions 095 * @param definition the structure's XML schema definition 096 * @param serviceContext the service context to be applied. Can set the 097 UUID, creation date, modification date, guest permissions, 098 and group permissions for the structure. 099 * @return the structure 100 * @throws PortalException if a user with the primary key could not be 101 found, if the XSD was not well-formed, or if a portal 102 exception occurred 103 * @deprecated As of 7.0.0, replaced by {@link #addStructure(long, long, 104 long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)} 105 */ 106 @java.lang.Deprecated 107 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 108 long userId, long groupId, long classNameId, 109 java.util.Map<java.util.Locale, java.lang.String> nameMap, 110 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 111 java.lang.String definition, 112 com.liferay.portal.service.ServiceContext serviceContext) 113 throws PortalException; 114 115 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 116 long userId, long groupId, long parentStructureId, long classNameId, 117 java.lang.String structureKey, 118 java.util.Map<java.util.Locale, java.lang.String> nameMap, 119 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 120 com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm, 121 com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout, 122 java.lang.String storageType, int type, 123 com.liferay.portal.service.ServiceContext serviceContext) 124 throws PortalException; 125 126 /** 127 * Adds a structure referencing its parent structure. 128 * 129 * @param userId the primary key of the structure's creator/owner 130 * @param groupId the primary key of the group 131 * @param parentStructureId the primary key of the parent structure 132 (optionally {@link 133 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants#DEFAULT_PARENT_STRUCTURE_ID}) 134 * @param classNameId the primary key of the class name for the 135 structure's related model 136 * @param structureKey the unique string identifying the structure 137 (optionally <code>null</code>) 138 * @param nameMap the structure's locales and localized names 139 * @param descriptionMap the structure's locales and localized 140 descriptions 141 * @param definition the structure's XML schema definition 142 * @param storageType the structure's storage type. It can be "xml" or 143 "expando". For more information, see {@link 144 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 145 * @param type the structure's type. For more information, see {@link 146 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 147 * @param serviceContext the service context to be applied. Can set the 148 UUID, creation date, modification date, guest permissions, 149 and group permissions for the structure. 150 * @return the structure 151 * @throws PortalException if a user with the primary key could not be 152 found, if the XSD was not well-formed, or if a portal 153 exception occurred 154 * @deprecated As of 7.0.0, replaced by {@link #addStructure(long, long, 155 long, long, String, Map, Map, DDMForm, DDMFormLayout, String, 156 int, ServiceContext)} 157 */ 158 @java.lang.Deprecated 159 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 160 long userId, long groupId, long parentStructureId, long classNameId, 161 java.lang.String structureKey, 162 java.util.Map<java.util.Locale, java.lang.String> nameMap, 163 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 164 java.lang.String definition, java.lang.String storageType, int type, 165 com.liferay.portal.service.ServiceContext serviceContext) 166 throws PortalException; 167 168 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 169 long userId, long groupId, java.lang.String parentStructureKey, 170 long classNameId, java.lang.String structureKey, 171 java.util.Map<java.util.Locale, java.lang.String> nameMap, 172 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 173 com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm, 174 com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout, 175 java.lang.String storageType, int type, 176 com.liferay.portal.service.ServiceContext serviceContext) 177 throws PortalException; 178 179 /** 180 * Adds a structure referencing a default parent structure if the parent 181 * structure is not found. 182 * 183 * @param userId the primary key of the structure's creator/owner 184 * @param groupId the primary key of the group 185 * @param parentStructureKey the unique string identifying the parent 186 structure (optionally <code>null</code>) 187 * @param classNameId the primary key of the class name for the 188 structure's related model 189 * @param structureKey the unique string identifying the structure 190 (optionally <code>null</code>) 191 * @param nameMap the structure's locales and localized names 192 * @param descriptionMap the structure's locales and localized 193 descriptions 194 * @param definition the structure's XML schema definition 195 * @param storageType the structure's storage type. It can be "xml" or 196 "expando". For more information, see {@link 197 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 198 * @param type the structure's type. For more information, see {@link 199 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 200 * @param serviceContext the service context to be applied. Can set the 201 UUID, creation date, modification date, guest permissions and 202 group permissions for the structure. 203 * @return the structure 204 * @throws PortalException if a user with the primary key could not be 205 found, if the XSD was not well-formed, or if a portal 206 exception occurred 207 * @deprecated As of 7.0.0, replaced by {@link #addStructure(long, long, 208 String, long, String, Map, Map, DDMForm, DDMFormLayout, 209 String, int, ServiceContext)} 210 */ 211 @java.lang.Deprecated 212 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure( 213 long userId, long groupId, java.lang.String parentStructureKey, 214 long classNameId, java.lang.String structureKey, 215 java.util.Map<java.util.Locale, java.lang.String> nameMap, 216 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 217 java.lang.String definition, java.lang.String storageType, int type, 218 com.liferay.portal.service.ServiceContext serviceContext) 219 throws PortalException; 220 221 /** 222 * Adds the resources to the structure. 223 * 224 * @param structure the structure to add resources to 225 * @param addGroupPermissions whether to add group permissions 226 * @param addGuestPermissions whether to add guest permissions 227 * @throws PortalException if a portal exception occurred 228 */ 229 public void addStructureResources( 230 com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure, 231 boolean addGroupPermissions, boolean addGuestPermissions) 232 throws PortalException; 233 234 /** 235 * Adds the model resources with the permissions to the structure. 236 * 237 * @param structure the structure to add resources to 238 * @param groupPermissions the group permissions to be added 239 * @param guestPermissions the guest permissions to be added 240 * @throws PortalException if a portal exception occurred 241 */ 242 public void addStructureResources( 243 com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure, 244 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 245 throws PortalException; 246 247 public void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId); 248 249 /** 250 * Copies a structure, creating a new structure with all the values 251 * extracted from the original one. The new structure supports a new name 252 * and description. 253 * 254 * @param userId the primary key of the structure's creator/owner 255 * @param structureId the primary key of the structure to be copied 256 * @param nameMap the new structure's locales and localized names 257 * @param descriptionMap the new structure's locales and localized 258 descriptions 259 * @param serviceContext the service context to be applied. Can set the 260 UUID, creation date, modification date, guest permissions, and 261 group permissions for the structure. 262 * @return the new structure 263 * @throws PortalException if a portal exception occurred 264 */ 265 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure( 266 long userId, long structureId, 267 java.util.Map<java.util.Locale, java.lang.String> nameMap, 268 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 269 com.liferay.portal.service.ServiceContext serviceContext) 270 throws PortalException; 271 272 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure( 273 long userId, long structureId, 274 com.liferay.portal.service.ServiceContext serviceContext) 275 throws PortalException; 276 277 /** 278 * Creates a new d d m structure with the primary key. Does not add the d d m structure to the database. 279 * 280 * @param structureId the primary key for the new d d m structure 281 * @return the new d d m structure 282 */ 283 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure createDDMStructure( 284 long structureId); 285 286 /** 287 * Deletes the d d m structure from the database. Also notifies the appropriate model listeners. 288 * 289 * @param ddmStructure the d d m structure 290 * @return the d d m structure that was removed 291 */ 292 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 293 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure( 294 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure); 295 296 /** 297 * Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners. 298 * 299 * @param structureId the primary key of the d d m structure 300 * @return the d d m structure that was removed 301 * @throws PortalException if a d d m structure with the primary key could not be found 302 */ 303 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 304 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure deleteDDMStructure( 305 long structureId) throws PortalException; 306 307 public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, 308 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure); 309 310 public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, 311 long structureId); 312 313 public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, 314 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> DDMStructures); 315 316 public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, 317 long[] structureIds); 318 319 /** 320 * @throws PortalException 321 */ 322 @Override 323 public com.liferay.portal.model.PersistedModel deletePersistedModel( 324 com.liferay.portal.model.PersistedModel persistedModel) 325 throws PortalException; 326 327 /** 328 * Deletes the matching structure and its resources. 329 * 330 * <p> 331 * Before deleting the structure, the system verifies whether the structure 332 * is required by another entity. If it is needed, an exception is thrown. 333 * </p> 334 * 335 * @param groupId the primary key of the group 336 * @param classNameId the primary key of the class name for the structure's 337 related model 338 * @param structureKey the unique string identifying the structure 339 * @throws PortalException if a portal exception occurred 340 */ 341 public void deleteStructure(long groupId, long classNameId, 342 java.lang.String structureKey) throws PortalException; 343 344 /** 345 * Deletes the structure and its resources. 346 * 347 * <p> 348 * Before deleting the structure, this method verifies whether the structure 349 * is required by another entity. If it is needed, an exception is thrown. 350 * </p> 351 * 352 * @param structure the structure to be deleted 353 * @throws PortalException if a portal exception occurred 354 */ 355 @com.liferay.portal.kernel.systemevent.SystemEvent(type = SystemEventConstants.TYPE_DELETE) 356 public void deleteStructure( 357 com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure) 358 throws PortalException; 359 360 /** 361 * Deletes the structure and its resources. 362 * 363 * <p> 364 * Before deleting the structure, the system verifies whether the structure 365 * is required by another entity. If it is needed, an exception is thrown. 366 * </p> 367 * 368 * @param structureId the primary key of the structure to be deleted 369 * @throws PortalException if a portal exception occurred 370 */ 371 public void deleteStructure(long structureId) throws PortalException; 372 373 /** 374 * Deletes all the structures of the group. 375 * 376 * <p> 377 * Before deleting the structures, the system verifies whether each 378 * structure is required by another entity. If any of the structures are 379 * needed, an exception is thrown. 380 * </p> 381 * 382 * @param groupId the primary key of the group 383 * @throws PortalException if a portal exception occurred 384 */ 385 public void deleteStructures(long groupId) throws PortalException; 386 387 public void deleteStructures(long groupId, long classNameId) 388 throws PortalException; 389 390 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 391 392 /** 393 * Performs a dynamic query on the database and returns the matching rows. 394 * 395 * @param dynamicQuery the dynamic query 396 * @return the matching rows 397 */ 398 public <T> java.util.List<T> dynamicQuery( 399 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 400 401 /** 402 * Performs a dynamic query on the database and returns a range of the matching rows. 403 * 404 * <p> 405 * 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. 406 * </p> 407 * 408 * @param dynamicQuery the dynamic query 409 * @param start the lower bound of the range of model instances 410 * @param end the upper bound of the range of model instances (not inclusive) 411 * @return the range of matching rows 412 */ 413 public <T> java.util.List<T> dynamicQuery( 414 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 415 int end); 416 417 /** 418 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 419 * 420 * <p> 421 * 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. 422 * </p> 423 * 424 * @param dynamicQuery the dynamic query 425 * @param start the lower bound of the range of model instances 426 * @param end the upper bound of the range of model instances (not inclusive) 427 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 428 * @return the ordered range of matching rows 429 */ 430 public <T> java.util.List<T> dynamicQuery( 431 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 432 int end, 433 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 434 435 /** 436 * Returns the number of rows matching the dynamic query. 437 * 438 * @param dynamicQuery the dynamic query 439 * @return the number of rows matching the dynamic query 440 */ 441 public long dynamicQueryCount( 442 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 443 444 /** 445 * Returns the number of rows matching the dynamic query. 446 * 447 * @param dynamicQuery the dynamic query 448 * @param projection the projection to apply to the query 449 * @return the number of rows matching the dynamic query 450 */ 451 public long dynamicQueryCount( 452 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 453 com.liferay.portal.kernel.dao.orm.Projection projection); 454 455 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 456 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructure( 457 long structureId); 458 459 /** 460 * Returns the d d m structure matching the UUID and group. 461 * 462 * @param uuid the d d m structure's UUID 463 * @param groupId the primary key of the group 464 * @return the matching d d m structure, or <code>null</code> if a matching d d m structure could not be found 465 */ 466 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 467 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchDDMStructureByUuidAndGroupId( 468 java.lang.String uuid, long groupId); 469 470 /** 471 * Returns the structure matching the class name ID, structure key, and 472 * group. 473 * 474 * @param groupId the primary key of the group 475 * @param classNameId the primary key of the class name for the structure's 476 related model 477 * @param structureKey the unique string identifying the structure 478 * @return the matching structure, or <code>null</code> if a matching 479 structure could not be found 480 */ 481 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 482 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 483 long groupId, long classNameId, java.lang.String structureKey); 484 485 /** 486 * Returns the structure matching the class name ID, structure key, and 487 * group, optionally searching ancestor sites (that have sharing enabled) 488 * and global scoped sites. 489 * 490 * <p> 491 * This method first searches in the group. If the structure is still not 492 * found and <code>includeAncestorStructures</code> is set to 493 * <code>true</code>, this method searches the group's ancestor sites (that 494 * have sharing enabled) and lastly searches global scoped sites. 495 * </p> 496 * 497 * @param groupId the primary key of the group 498 * @param classNameId the primary key of the class name for the structure's 499 related model 500 * @param structureKey the unique string identifying the structure 501 * @param includeAncestorStructures whether to include ancestor sites (that 502 have sharing enabled) and include global scoped sites in the 503 search 504 * @return the matching structure, or <code>null</code> if a matching 505 structure could not be found 506 * @throws PortalException if a portal exception occurred 507 */ 508 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 509 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 510 long groupId, long classNameId, java.lang.String structureKey, 511 boolean includeAncestorStructures) throws PortalException; 512 513 /** 514 * Returns the structure with the ID. 515 * 516 * @param structureId the primary key of the structure 517 * @return the structure with the structure ID, or <code>null</code> if a 518 matching structure could not be found 519 */ 520 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 521 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure( 522 long structureId); 523 524 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 525 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 526 527 /** 528 * Returns the Spring bean ID for this bean. 529 * 530 * @return the Spring bean ID for this bean 531 */ 532 public java.lang.String getBeanIdentifier(); 533 534 /** 535 * Returns all the structures matching the class name ID. 536 * 537 * @param companyId the primary key of the structure's company 538 * @param classNameId the primary key of the class name for the structure's 539 related model 540 * @return the structures matching the class name ID 541 */ 542 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 543 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 544 long companyId, long classNameId); 545 546 /** 547 * Returns all the structures matching the class name ID ordered by the 548 * comparator. 549 * 550 * @param companyId the primary key of the structure's company 551 * @param classNameId the primary key of the class name for the structure's 552 related model 553 * @param orderByComparator the comparator to order the structures 554 (optionally <code>null</code>) 555 * @return the matching structures ordered by the comparator 556 */ 557 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 558 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 559 long companyId, long classNameId, 560 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> orderByComparator); 561 562 /** 563 * Returns a range of all the structures matching the class name ID. 564 * 565 * <p> 566 * Useful when paginating results. Returns a maximum of <code>end - 567 * start</code> instances. <code>start</code> and <code>end</code> are not 568 * primary keys, they are indexes in the result set. Thus, <code>0</code> 569 * refers to the first result in the set. Setting both <code>start</code> 570 * and <code>end</code> to {@link 571 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 572 * result set. 573 * </p> 574 * 575 * @param companyId the primary key of the structure's company 576 * @param classNameId the primary key of the class name for the structure's 577 related model 578 * @param start the lower bound of the range of structures to return 579 * @param end the upper bound of the range of structures to return (not 580 inclusive) 581 * @return the range of matching structures 582 */ 583 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 584 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures( 585 long companyId, long classNameId, int start, int end); 586 587 /** 588 * Returns the d d m structure with the primary key. 589 * 590 * @param structureId the primary key of the d d m structure 591 * @return the d d m structure 592 * @throws PortalException if a d d m structure with the primary key could not be found 593 */ 594 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 595 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructure( 596 long structureId) throws PortalException; 597 598 /** 599 * Returns the d d m structure matching the UUID and group. 600 * 601 * @param uuid the d d m structure's UUID 602 * @param groupId the primary key of the group 603 * @return the matching d d m structure 604 * @throws PortalException if a matching d d m structure could not be found 605 */ 606 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 607 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructureByUuidAndGroupId( 608 java.lang.String uuid, long groupId) throws PortalException; 609 610 /** 611 * Returns a range of all the d d m structures. 612 * 613 * <p> 614 * 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. 615 * </p> 616 * 617 * @param start the lower bound of the range of d d m structures 618 * @param end the upper bound of the range of d d m structures (not inclusive) 619 * @return the range of d d m structures 620 */ 621 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 622 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructures( 623 int start, int end); 624 625 /** 626 * Returns all the d d m structures matching the UUID and company. 627 * 628 * @param uuid the UUID of the d d m structures 629 * @param companyId the primary key of the company 630 * @return the matching d d m structures, or an empty list if no matches were found 631 */ 632 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 633 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructuresByUuidAndCompanyId( 634 java.lang.String uuid, long companyId); 635 636 /** 637 * Returns a range of d d m structures matching the UUID and company. 638 * 639 * @param uuid the UUID of the d d m structures 640 * @param companyId the primary key of the company 641 * @param start the lower bound of the range of d d m structures 642 * @param end the upper bound of the range of d d m structures (not inclusive) 643 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 644 * @return the range of matching d d m structures, or an empty list if no matches were found 645 */ 646 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 647 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructuresByUuidAndCompanyId( 648 java.lang.String uuid, long companyId, int start, int end, 649 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> orderByComparator); 650 651 /** 652 * Returns the number of d d m structures. 653 * 654 * @return the number of d d m structures 655 */ 656 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 657 public int getDDMStructuresCount(); 658 659 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 660 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures( 661 long fileEntryTypeId); 662 663 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 664 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures( 665 long fileEntryTypeId, int start, int end); 666 667 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 668 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeDDMStructures( 669 long fileEntryTypeId, int start, int end, 670 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> orderByComparator); 671 672 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 673 public int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId); 674 675 /** 676 * Returns the fileEntryTypeIds of the document library file entry types associated with the d d m structure. 677 * 678 * @param structureId the structureId of the d d m structure 679 * @return long[] the fileEntryTypeIds of document library file entry types associated with the d d m structure 680 */ 681 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 682 public long[] getDLFileEntryTypePrimaryKeys(long structureId); 683 684 /** 685 * Returns all the structures for the document library file entry type. 686 * 687 * @param dlFileEntryTypeId the primary key of the document library file 688 entry type 689 * @return the structures for the document library file entry type 690 */ 691 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 692 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures( 693 long dlFileEntryTypeId); 694 695 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 696 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 697 com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext); 698 699 @Override 700 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 701 public com.liferay.portal.model.PersistedModel getPersistedModel( 702 java.io.Serializable primaryKeyObj) throws PortalException; 703 704 /** 705 * Returns the structure matching the class name ID, structure key, and 706 * group. 707 * 708 * @param groupId the primary key of the structure's group 709 * @param classNameId the primary key of the class name for the structure's 710 related model 711 * @param structureKey the unique string identifying the structure 712 * @return the matching structure 713 * @throws PortalException if a matching structure could not be found 714 */ 715 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 716 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 717 long groupId, long classNameId, java.lang.String structureKey) 718 throws PortalException; 719 720 /** 721 * Returns the structure matching the class name ID, structure key, and 722 * group, optionally searching ancestor sites (that have sharing enabled) 723 * and global scoped sites. 724 * 725 * <p> 726 * This method first searches in the group. If the structure is still not 727 * found and <code>includeAncestorStructures</code> is set to 728 * <code>true</code>, this method searches the group's ancestor sites (that 729 * have sharing enabled) and lastly searches global scoped sites. 730 * </p> 731 * 732 * @param groupId the primary key of the structure's group 733 * @param classNameId the primary key of the class name for the structure's 734 related model 735 * @param structureKey the unique string identifying the structure 736 * @param includeAncestorStructures whether to include ancestor sites (that 737 have sharing enabled) and include global scoped sites in the 738 search in the search 739 * @return the matching structure 740 * @throws PortalException if a matching structure could not be found 741 */ 742 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 743 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 744 long groupId, long classNameId, java.lang.String structureKey, 745 boolean includeAncestorStructures) throws PortalException; 746 747 /** 748 * Returns all the structures matching the group, name, and description. 749 * 750 * @param groupId the primary key of the structure's group 751 * @param name the structure's name 752 * @param description the structure's description 753 * @return the matching structures 754 */ 755 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 756 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure( 757 long groupId, java.lang.String name, java.lang.String description); 758 759 /** 760 * Returns the structure with the ID. 761 * 762 * @param structureId the primary key of the structure 763 * @return the structure with the ID 764 * @throws PortalException if a structure with the ID could not be found 765 */ 766 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 767 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure( 768 long structureId) throws PortalException; 769 770 /** 771 * Returns all the structures present in the system. 772 * 773 * @return the structures present in the system 774 */ 775 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 776 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(); 777 778 /** 779 * Returns all the structures present in the group. 780 * 781 * @param groupId the primary key of the group 782 * @return the structures present in the group 783 */ 784 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 785 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 786 long groupId); 787 788 /** 789 * Returns all the structures matching class name ID and group. 790 * 791 * @param groupId the primary key of the group 792 * @param classNameId the primary key of the class name for the structure's 793 related model 794 * @return the matching structures 795 */ 796 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 797 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 798 long groupId, long classNameId); 799 800 /** 801 * Returns a range of all the structures that match the class name ID and 802 * group. 803 * 804 * <p> 805 * Useful when paginating results. Returns a maximum of <code>end - 806 * start</code> instances. <code>start</code> and <code>end</code> are not 807 * primary keys, they are indexes in the result set. Thus, <code>0</code> 808 * refers to the first result in the set. Setting both <code>start</code> 809 * and <code>end</code> to {@link 810 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 811 * result set. 812 * </p> 813 * 814 * @param groupId the primary key of the group 815 * @param classNameId the primary key of the class name for the structure's 816 related model 817 * @param start the lower bound of the range of structures to return 818 * @param end the upper bound of the range of structures to return (not 819 inclusive) 820 * @return the range of matching structures 821 */ 822 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 823 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 824 long groupId, long classNameId, int start, int end); 825 826 /** 827 * Returns an ordered range of all the structures matching the class name ID 828 * and group. 829 * 830 * <p> 831 * Useful when paginating results. Returns a maximum of <code>end - 832 * start</code> instances. <code>start</code> and <code>end</code> are not 833 * primary keys, they are indexes in the result set. Thus, <code>0</code> 834 * refers to the first result in the set. Setting both <code>start</code> 835 * and <code>end</code> to {@link 836 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 837 * result set. 838 * </p> 839 * 840 * @param groupId the primary key of the group 841 * @param classNameId the primary key of the class name for the structure's 842 related model 843 * @param start the lower bound of the range of structures to return 844 * @param end the upper bound of the range of structures to return (not 845 inclusive) 846 * @param orderByComparator the comparator to order the structures 847 (optionally <code>null</code>) 848 * @return the range of matching structures ordered by the comparator 849 */ 850 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 851 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 852 long groupId, long classNameId, int start, int end, 853 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> orderByComparator); 854 855 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 856 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 857 long groupId, java.lang.String name, java.lang.String description); 858 859 /** 860 * Returns a range of all the structures belonging to the group. 861 * 862 * <p> 863 * Useful when paginating results. Returns a maximum of <code>end - 864 * start</code> instances. <code>start</code> and <code>end</code> are not 865 * primary keys, they are indexes in the result set. Thus, <code>0</code> 866 * refers to the first result in the set. Setting both <code>start</code> 867 * and <code>end</code> to {@link 868 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 869 * result set. 870 * </p> 871 * 872 * @param groupId the primary key of the group 873 * @param start the lower bound of the range of structures to return 874 * @param end the upper bound of the range of structures to return (not 875 inclusive) 876 * @return the range of matching structures 877 */ 878 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 879 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 880 long groupId, int start, int end); 881 882 /** 883 * Returns all the structures belonging to the groups. 884 * 885 * @param groupIds the primary keys of the groups 886 * @return the structures belonging to the groups 887 */ 888 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 889 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 890 long[] groupIds); 891 892 /** 893 * Returns all the structures matching the class name ID and belonging to 894 * the groups. 895 * 896 * @param groupIds the primary keys of the groups 897 * @param classNameId the primary key of the class name for the structure's 898 related model 899 * @return the matching structures 900 */ 901 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 902 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 903 long[] groupIds, long classNameId); 904 905 /** 906 * Returns a range of all the structures matching the class name ID and 907 * belonging to the groups. 908 * 909 * <p> 910 * Useful when paginating results. Returns a maximum of <code>end - 911 * start</code> instances. <code>start</code> and <code>end</code> are not 912 * primary keys, they are indexes in the result set. Thus, <code>0</code> 913 * refers to the first result in the set. Setting both <code>start</code> 914 * and <code>end</code> to {@link 915 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 916 * result set. 917 * </p> 918 * 919 * @param groupIds the primary keys of the groups 920 * @param classNameId the primary key of the class name for the structure's 921 related model 922 * @param start the lower bound of the range of structures to return 923 * @param end the upper bound of the range of structures to return (not 924 inclusive) 925 * @return the range of matching structures 926 */ 927 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 928 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures( 929 long[] groupIds, long classNameId, int start, int end); 930 931 /** 932 * Returns the number of structures belonging to the group. 933 * 934 * @param groupId the primary key of the group 935 * @return the number of structures belonging to the group 936 */ 937 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 938 public int getStructuresCount(long groupId); 939 940 /** 941 * Returns the number of structures matching the class name ID and group. 942 * 943 * @param groupId the primary key of the group 944 * @param classNameId the primary key of the class name for the structure's 945 related model 946 * @return the number of matching structures 947 */ 948 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 949 public int getStructuresCount(long groupId, long classNameId); 950 951 /** 952 * Returns the number of structures matching the class name ID and belonging 953 * to the groups. 954 * 955 * @param groupIds the primary keys of the groups 956 * @param classNameId the primary key of the class name for the structure's 957 related model 958 * @return the number of matching structures 959 */ 960 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 961 public int getStructuresCount(long[] groupIds, long classNameId); 962 963 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 964 public boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId, 965 long structureId); 966 967 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 968 public boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId); 969 970 public void revertStructure(long userId, long structureId, 971 java.lang.String version, 972 com.liferay.portal.service.ServiceContext serviceContext) 973 throws PortalException; 974 975 /** 976 * Returns an ordered range of all the structures matching the groups and 977 * class name IDs, and matching the keywords in the structure names and 978 * descriptions. 979 * 980 * <p> 981 * Useful when paginating results. Returns a maximum of <code>end - 982 * start</code> instances. <code>start</code> and <code>end</code> are not 983 * primary keys, they are indexes in the result set. Thus, <code>0</code> 984 * refers to the first result in the set. Setting both <code>start</code> 985 * and <code>end</code> to {@link 986 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 987 * result set. 988 * </p> 989 * 990 * @param companyId the primary key of the structure's company 991 * @param groupIds the primary keys of the groups 992 * @param classNameId the primary key of the class name of the model the 993 structure is related to 994 * @param keywords the keywords (space separated), which may occur in the 995 structure's name or description (optionally <code>null</code>) 996 * @param start the lower bound of the range of structures to return 997 * @param end the upper bound of the range of structures to return (not 998 inclusive) 999 * @param orderByComparator the comparator to order the structures 1000 (optionally <code>null</code>) 1001 * @return the range of matching structures ordered by the comparator 1002 */ 1003 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1004 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search( 1005 long companyId, long[] groupIds, long classNameId, 1006 java.lang.String keywords, int start, int end, 1007 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> orderByComparator); 1008 1009 /** 1010 * Returns an ordered range of all the structures matching the groups, class 1011 * name IDs, name keyword, description keyword, storage type, and type. 1012 * 1013 * <p> 1014 * Useful when paginating results. Returns a maximum of <code>end - 1015 * start</code> instances. <code>start</code> and <code>end</code> are not 1016 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1017 * refers to the first result in the set. Setting both <code>start</code> 1018 * and <code>end</code> to {@link 1019 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1020 * result set. 1021 * </p> 1022 * 1023 * @param companyId the primary key of the structure's company 1024 * @param groupIds the primary keys of the groups 1025 * @param classNameId the primary key of the class name of the model the 1026 structure is related to 1027 * @param name the name keywords 1028 * @param description the description keywords 1029 * @param storageType the structure's storage type. It can be "xml" or 1030 "expando". For more information, see {@link 1031 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 1032 * @param type the structure's type. For more information, see {@link 1033 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1034 * @param andOperator whether every field must match its keywords, or just 1035 one field 1036 * @param start the lower bound of the range of structures to return 1037 * @param end the upper bound of the range of structures to return (not 1038 inclusive) 1039 * @param orderByComparator the comparator to order the structures 1040 (optionally <code>null</code>) 1041 * @return the range of matching structures ordered by the comparator 1042 */ 1043 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1044 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search( 1045 long companyId, long[] groupIds, long classNameId, 1046 java.lang.String name, java.lang.String description, 1047 java.lang.String storageType, int type, boolean andOperator, int start, 1048 int end, 1049 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> orderByComparator); 1050 1051 /** 1052 * Returns the number of structures matching the groups and class name IDs, 1053 * and matching the keywords in the structure names and descriptions. 1054 * 1055 * @param companyId the primary key of the structure's company 1056 * @param groupIds the primary keys of the groups 1057 * @param classNameId the primary key of the class name of the model the 1058 structure is related to 1059 * @param keywords the keywords (space separated), which may occur in the 1060 structure's name or description (optionally <code>null</code>) 1061 * @return the number of matching structures 1062 */ 1063 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1064 public int searchCount(long companyId, long[] groupIds, long classNameId, 1065 java.lang.String keywords); 1066 1067 /** 1068 * Returns the number of structures matching the groups, class name IDs, 1069 * name keyword, description keyword, storage type, and type 1070 * 1071 * @param companyId the primary key of the structure's company 1072 * @param groupIds the primary keys of the groups 1073 * @param name the name keywords 1074 * @param description the description keywords 1075 * @param storageType the structure's storage type. It can be "xml" or 1076 "expando". For more information, see {@link 1077 com.liferay.portlet.dynamicdatamapping.storage.StorageType}. 1078 * @param type the structure's type. For more information, see {@link 1079 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1080 * @param andOperator whether every field must match its keywords, or just 1081 one field 1082 * @return the number of matching structures 1083 */ 1084 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1085 public int searchCount(long companyId, long[] groupIds, long classNameId, 1086 java.lang.String name, java.lang.String description, 1087 java.lang.String storageType, int type, boolean andOperator); 1088 1089 /** 1090 * Sets the Spring bean ID for this bean. 1091 * 1092 * @param beanIdentifier the Spring bean ID for this bean 1093 */ 1094 public void setBeanIdentifier(java.lang.String beanIdentifier); 1095 1096 public void setDLFileEntryTypeDDMStructures(long fileEntryTypeId, 1097 long[] structureIds); 1098 1099 /** 1100 * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 1101 * 1102 * @param ddmStructure the d d m structure 1103 * @return the d d m structure that was updated 1104 */ 1105 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 1106 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure( 1107 com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure); 1108 1109 /** 1110 * Updates the structure matching the class name ID, structure key, and 1111 * group, replacing its old parent structure, name map, description map, and 1112 * XSD with new ones. 1113 * 1114 * @param groupId the primary key of the group 1115 * @param parentStructureId the primary key of the new parent structure 1116 * @param classNameId the primary key of the class name for the 1117 structure's related model 1118 * @param structureKey the unique string identifying the structure 1119 * @param nameMap the structure's new locales and localized names 1120 * @param descriptionMap the structure's new locales and localized 1121 description 1122 * @param definition the structure's new XML schema definition 1123 * @param serviceContext the service context to be applied. Can set the 1124 structure's modification date. 1125 * @return the updated structure 1126 * @throws PortalException if a matching structure could not be found, 1127 if the XSD was not well-formed, or if a portal exception 1128 occurred 1129 * @deprecated As of 7.0.0, replaced by {@link #updateStructure(long, long, 1130 long, long, String, Map, Map, DDMForm, DDMFormLayout, 1131 ServiceContext)} 1132 */ 1133 @java.lang.Deprecated 1134 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1135 long groupId, long parentStructureId, long classNameId, 1136 java.lang.String structureKey, 1137 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1138 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1139 java.lang.String definition, 1140 com.liferay.portal.service.ServiceContext serviceContext) 1141 throws PortalException; 1142 1143 /** 1144 * Updates the structure matching the structure ID, replacing its old parent 1145 * structure, name map, description map, and XSD with new ones. 1146 * 1147 * @param structureId the primary key of the structure 1148 * @param parentStructureId the primary key of the new parent structure 1149 * @param nameMap the structure's new locales and localized names 1150 * @param descriptionMap the structure's new locales and localized 1151 descriptions 1152 * @param definition the structure's new XML schema definition 1153 * @param serviceContext the service context to be applied. Can set the 1154 structure's modification date. 1155 * @return the updated structure 1156 * @throws PortalException if a matching structure could not be found, 1157 if the XSD was not well-formed, or if a portal exception 1158 occurred 1159 * @deprecated As of 7.0.0, replaced by {@link #updateStructure(long, long, 1160 long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)} 1161 */ 1162 @java.lang.Deprecated 1163 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1164 long structureId, long parentStructureId, 1165 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1166 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1167 java.lang.String definition, 1168 com.liferay.portal.service.ServiceContext serviceContext) 1169 throws PortalException; 1170 1171 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1172 long userId, long groupId, long parentStructureId, long classNameId, 1173 java.lang.String structureKey, 1174 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1175 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1176 com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm, 1177 com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout, 1178 com.liferay.portal.service.ServiceContext serviceContext) 1179 throws PortalException; 1180 1181 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1182 long userId, long structureId, 1183 com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm, 1184 com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout, 1185 com.liferay.portal.service.ServiceContext serviceContext) 1186 throws PortalException; 1187 1188 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure( 1189 long userId, long structureId, long parentStructureId, 1190 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1191 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1192 com.liferay.portlet.dynamicdatamapping.model.DDMForm ddmForm, 1193 com.liferay.portlet.dynamicdatamapping.model.DDMFormLayout ddmFormLayout, 1194 com.liferay.portal.service.ServiceContext serviceContext) 1195 throws PortalException; 1196 1197 /** 1198 * Updates the structure matching the structure ID, replacing its XSD with a 1199 * new one. 1200 * 1201 * @param structureId the primary key of the structure 1202 * @param definition the structure's new XML schema definition 1203 * @param serviceContext the service context to be applied. Can set the 1204 structure's modification date. 1205 * @return the updated structure 1206 * @throws PortalException if a matching structure could not be found, 1207 if the XSD was not well-formed, or if a portal exception 1208 occurred 1209 * @deprecated As of 7.0.0, replaced by {@link #updateStructure(long, 1210 DDMForm, DDMFormLayout, ServiceContext)} 1211 */ 1212 @java.lang.Deprecated 1213 public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateXSD( 1214 long structureId, java.lang.String definition, 1215 com.liferay.portal.service.ServiceContext serviceContext) 1216 throws PortalException; 1217 }