com.liferay.dynamic.data.mapping.service.persistence.DDMStructureLayoutPersistence Maven / Gradle / Ivy
Show all versions of com.liferay.dynamic.data.mapping.api Show documentation
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.dynamic.data.mapping.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.dynamic.data.mapping.exception.NoSuchStructureLayoutException;
import com.liferay.dynamic.data.mapping.model.DDMStructureLayout;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
/**
* The persistence interface for the d d m structure layout service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.dynamic.data.mapping.service.persistence.impl.DDMStructureLayoutPersistenceImpl
* @see DDMStructureLayoutUtil
* @generated
*/
@ProviderType
public interface DDMStructureLayoutPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link DDMStructureLayoutUtil} to access the d d m structure layout persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the d d m structure layouts where uuid = ?.
*
* @param uuid the uuid
* @return the matching d d m structure layouts
*/
public java.util.List findByUuid(java.lang.String uuid);
/**
* Returns a range of all the d d m structure layouts where uuid = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param uuid the uuid
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @return the range of matching d d m structure layouts
*/
public java.util.List findByUuid(
java.lang.String uuid, int start, int end);
/**
* Returns an ordered range of all the d d m structure layouts where uuid = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param uuid the uuid
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching d d m structure layouts
*/
public java.util.List findByUuid(
java.lang.String uuid, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns an ordered range of all the d d m structure layouts where uuid = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param uuid the uuid
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of matching d d m structure layouts
*/
public java.util.List findByUuid(
java.lang.String uuid, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
boolean retrieveFromCache);
/**
* Returns the first d d m structure layout in the ordered set where uuid = ?.
*
* @param uuid the uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching d d m structure layout
* @throws NoSuchStructureLayoutException if a matching d d m structure layout could not be found
*/
public DDMStructureLayout findByUuid_First(java.lang.String uuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws NoSuchStructureLayoutException;
/**
* Returns the first d d m structure layout in the ordered set where uuid = ?.
*
* @param uuid the uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByUuid_First(java.lang.String uuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns the last d d m structure layout in the ordered set where uuid = ?.
*
* @param uuid the uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching d d m structure layout
* @throws NoSuchStructureLayoutException if a matching d d m structure layout could not be found
*/
public DDMStructureLayout findByUuid_Last(java.lang.String uuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws NoSuchStructureLayoutException;
/**
* Returns the last d d m structure layout in the ordered set where uuid = ?.
*
* @param uuid the uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByUuid_Last(java.lang.String uuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns the d d m structure layouts before and after the current d d m structure layout in the ordered set where uuid = ?.
*
* @param structureLayoutId the primary key of the current d d m structure layout
* @param uuid the uuid
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next d d m structure layout
* @throws NoSuchStructureLayoutException if a d d m structure layout with the primary key could not be found
*/
public DDMStructureLayout[] findByUuid_PrevAndNext(long structureLayoutId,
java.lang.String uuid,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws NoSuchStructureLayoutException;
/**
* Removes all the d d m structure layouts where uuid = ? from the database.
*
* @param uuid the uuid
*/
public void removeByUuid(java.lang.String uuid);
/**
* Returns the number of d d m structure layouts where uuid = ?.
*
* @param uuid the uuid
* @return the number of matching d d m structure layouts
*/
public int countByUuid(java.lang.String uuid);
/**
* Returns the d d m structure layout where uuid = ? and groupId = ? or throws a {@link NoSuchStructureLayoutException} if it could not be found.
*
* @param uuid the uuid
* @param groupId the group ID
* @return the matching d d m structure layout
* @throws NoSuchStructureLayoutException if a matching d d m structure layout could not be found
*/
public DDMStructureLayout findByUUID_G(java.lang.String uuid, long groupId)
throws NoSuchStructureLayoutException;
/**
* Returns the d d m structure layout where uuid = ? and groupId = ? or returns null if it could not be found. Uses the finder cache.
*
* @param uuid the uuid
* @param groupId the group ID
* @return the matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByUUID_G(java.lang.String uuid, long groupId);
/**
* Returns the d d m structure layout where uuid = ? and groupId = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param uuid the uuid
* @param groupId the group ID
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByUUID_G(java.lang.String uuid,
long groupId, boolean retrieveFromCache);
/**
* Removes the d d m structure layout where uuid = ? and groupId = ? from the database.
*
* @param uuid the uuid
* @param groupId the group ID
* @return the d d m structure layout that was removed
*/
public DDMStructureLayout removeByUUID_G(java.lang.String uuid, long groupId)
throws NoSuchStructureLayoutException;
/**
* Returns the number of d d m structure layouts where uuid = ? and groupId = ?.
*
* @param uuid the uuid
* @param groupId the group ID
* @return the number of matching d d m structure layouts
*/
public int countByUUID_G(java.lang.String uuid, long groupId);
/**
* Returns all the d d m structure layouts where uuid = ? and companyId = ?.
*
* @param uuid the uuid
* @param companyId the company ID
* @return the matching d d m structure layouts
*/
public java.util.List findByUuid_C(
java.lang.String uuid, long companyId);
/**
* Returns a range of all the d d m structure layouts where uuid = ? and companyId = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param uuid the uuid
* @param companyId the company ID
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @return the range of matching d d m structure layouts
*/
public java.util.List findByUuid_C(
java.lang.String uuid, long companyId, int start, int end);
/**
* Returns an ordered range of all the d d m structure layouts where uuid = ? and companyId = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param uuid the uuid
* @param companyId the company ID
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching d d m structure layouts
*/
public java.util.List findByUuid_C(
java.lang.String uuid, long companyId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns an ordered range of all the d d m structure layouts where uuid = ? and companyId = ?.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param uuid the uuid
* @param companyId the company ID
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of matching d d m structure layouts
*/
public java.util.List findByUuid_C(
java.lang.String uuid, long companyId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
boolean retrieveFromCache);
/**
* Returns the first d d m structure layout in the ordered set where uuid = ? and companyId = ?.
*
* @param uuid the uuid
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching d d m structure layout
* @throws NoSuchStructureLayoutException if a matching d d m structure layout could not be found
*/
public DDMStructureLayout findByUuid_C_First(java.lang.String uuid,
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws NoSuchStructureLayoutException;
/**
* Returns the first d d m structure layout in the ordered set where uuid = ? and companyId = ?.
*
* @param uuid the uuid
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByUuid_C_First(java.lang.String uuid,
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns the last d d m structure layout in the ordered set where uuid = ? and companyId = ?.
*
* @param uuid the uuid
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching d d m structure layout
* @throws NoSuchStructureLayoutException if a matching d d m structure layout could not be found
*/
public DDMStructureLayout findByUuid_C_Last(java.lang.String uuid,
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws NoSuchStructureLayoutException;
/**
* Returns the last d d m structure layout in the ordered set where uuid = ? and companyId = ?.
*
* @param uuid the uuid
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByUuid_C_Last(java.lang.String uuid,
long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns the d d m structure layouts before and after the current d d m structure layout in the ordered set where uuid = ? and companyId = ?.
*
* @param structureLayoutId the primary key of the current d d m structure layout
* @param uuid the uuid
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next d d m structure layout
* @throws NoSuchStructureLayoutException if a d d m structure layout with the primary key could not be found
*/
public DDMStructureLayout[] findByUuid_C_PrevAndNext(
long structureLayoutId, java.lang.String uuid, long companyId,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws NoSuchStructureLayoutException;
/**
* Removes all the d d m structure layouts where uuid = ? and companyId = ? from the database.
*
* @param uuid the uuid
* @param companyId the company ID
*/
public void removeByUuid_C(java.lang.String uuid, long companyId);
/**
* Returns the number of d d m structure layouts where uuid = ? and companyId = ?.
*
* @param uuid the uuid
* @param companyId the company ID
* @return the number of matching d d m structure layouts
*/
public int countByUuid_C(java.lang.String uuid, long companyId);
/**
* Returns the d d m structure layout where structureVersionId = ? or throws a {@link NoSuchStructureLayoutException} if it could not be found.
*
* @param structureVersionId the structure version ID
* @return the matching d d m structure layout
* @throws NoSuchStructureLayoutException if a matching d d m structure layout could not be found
*/
public DDMStructureLayout findByStructureVersionId(long structureVersionId)
throws NoSuchStructureLayoutException;
/**
* Returns the d d m structure layout where structureVersionId = ? or returns null if it could not be found. Uses the finder cache.
*
* @param structureVersionId the structure version ID
* @return the matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByStructureVersionId(long structureVersionId);
/**
* Returns the d d m structure layout where structureVersionId = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param structureVersionId the structure version ID
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the matching d d m structure layout, or null if a matching d d m structure layout could not be found
*/
public DDMStructureLayout fetchByStructureVersionId(
long structureVersionId, boolean retrieveFromCache);
/**
* Removes the d d m structure layout where structureVersionId = ? from the database.
*
* @param structureVersionId the structure version ID
* @return the d d m structure layout that was removed
*/
public DDMStructureLayout removeByStructureVersionId(
long structureVersionId) throws NoSuchStructureLayoutException;
/**
* Returns the number of d d m structure layouts where structureVersionId = ?.
*
* @param structureVersionId the structure version ID
* @return the number of matching d d m structure layouts
*/
public int countByStructureVersionId(long structureVersionId);
/**
* Caches the d d m structure layout in the entity cache if it is enabled.
*
* @param ddmStructureLayout the d d m structure layout
*/
public void cacheResult(DDMStructureLayout ddmStructureLayout);
/**
* Caches the d d m structure layouts in the entity cache if it is enabled.
*
* @param ddmStructureLayouts the d d m structure layouts
*/
public void cacheResult(
java.util.List ddmStructureLayouts);
/**
* Creates a new d d m structure layout with the primary key. Does not add the d d m structure layout to the database.
*
* @param structureLayoutId the primary key for the new d d m structure layout
* @return the new d d m structure layout
*/
public DDMStructureLayout create(long structureLayoutId);
/**
* Removes the d d m structure layout with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param structureLayoutId the primary key of the d d m structure layout
* @return the d d m structure layout that was removed
* @throws NoSuchStructureLayoutException if a d d m structure layout with the primary key could not be found
*/
public DDMStructureLayout remove(long structureLayoutId)
throws NoSuchStructureLayoutException;
public DDMStructureLayout updateImpl(DDMStructureLayout ddmStructureLayout);
/**
* Returns the d d m structure layout with the primary key or throws a {@link NoSuchStructureLayoutException} if it could not be found.
*
* @param structureLayoutId the primary key of the d d m structure layout
* @return the d d m structure layout
* @throws NoSuchStructureLayoutException if a d d m structure layout with the primary key could not be found
*/
public DDMStructureLayout findByPrimaryKey(long structureLayoutId)
throws NoSuchStructureLayoutException;
/**
* Returns the d d m structure layout with the primary key or returns null if it could not be found.
*
* @param structureLayoutId the primary key of the d d m structure layout
* @return the d d m structure layout, or null if a d d m structure layout with the primary key could not be found
*/
public DDMStructureLayout fetchByPrimaryKey(long structureLayoutId);
@Override
public java.util.Map fetchByPrimaryKeys(
java.util.Set primaryKeys);
/**
* Returns all the d d m structure layouts.
*
* @return the d d m structure layouts
*/
public java.util.List findAll();
/**
* Returns a range of all the d d m structure layouts.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @return the range of d d m structure layouts
*/
public java.util.List findAll(int start, int end);
/**
* Returns an ordered range of all the d d m structure layouts.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of d d m structure layouts
*/
public java.util.List findAll(int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator);
/**
* Returns an ordered range of all the d d m structure layouts.
*
*
* Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link QueryUtil#ALL_POS} will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not {@link QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link DDMStructureLayoutModelImpl}. If both orderByComparator 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.
*
*
* @param start the lower bound of the range of d d m structure layouts
* @param end the upper bound of the range of d d m structure layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of d d m structure layouts
*/
public java.util.List findAll(int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
boolean retrieveFromCache);
/**
* Removes all the d d m structure layouts from the database.
*/
public void removeAll();
/**
* Returns the number of d d m structure layouts.
*
* @return the number of d d m structure layouts
*/
public int countAll();
@Override
public java.util.Set getBadColumnNames();
}