com.liferay.dynamic.data.mapping.service.DDMStorageLinkLocalService Maven / Gradle / Ivy
/**
* 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;
import aQute.bnd.annotation.ProviderType;
import com.liferay.dynamic.data.mapping.model.DDMStorageLink;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for DDMStorageLink. Methods of this
* service will not have security checks based on the propagated JAAS
* credentials because this service can only be accessed from within the same
* VM.
*
* @author Brian Wing Shun Chan
* @see DDMStorageLinkLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface DDMStorageLinkLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link DDMStorageLinkLocalServiceUtil} to access the ddm storage link local service. Add custom service methods to com.liferay.dynamic.data.mapping.service.impl.DDMStorageLinkLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the ddm storage link to the database. Also notifies the appropriate model listeners.
*
* @param ddmStorageLink the ddm storage link
* @return the ddm storage link that was added
*/
@Indexable(type = IndexableType.REINDEX)
public DDMStorageLink addDDMStorageLink(DDMStorageLink ddmStorageLink);
public DDMStorageLink addStorageLink(
long classNameId, long classPK, long structureVersionId,
ServiceContext serviceContext);
/**
* Creates a new ddm storage link with the primary key. Does not add the ddm storage link to the database.
*
* @param storageLinkId the primary key for the new ddm storage link
* @return the new ddm storage link
*/
@Transactional(enabled = false)
public DDMStorageLink createDDMStorageLink(long storageLinkId);
public void deleteClassStorageLink(long classPK);
/**
* Deletes the ddm storage link from the database. Also notifies the appropriate model listeners.
*
* @param ddmStorageLink the ddm storage link
* @return the ddm storage link that was removed
*/
@Indexable(type = IndexableType.DELETE)
public DDMStorageLink deleteDDMStorageLink(DDMStorageLink ddmStorageLink);
/**
* Deletes the ddm storage link with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param storageLinkId the primary key of the ddm storage link
* @return the ddm storage link that was removed
* @throws PortalException if a ddm storage link with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public DDMStorageLink deleteDDMStorageLink(long storageLinkId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public void deleteStorageLink(DDMStorageLink storageLink);
public void deleteStorageLink(long storageLinkId);
public void deleteStructureStorageLinks(long structureId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery dynamicQuery);
/**
* Performs a dynamic query on the database and returns a range of the matching rows.
*
*
* 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.dynamic.data.mapping.model.impl.DDMStorageLinkModelImpl. 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 dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* Performs a dynamic query on the database and returns an ordered range of the matching rows.
*
*
* 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.dynamic.data.mapping.model.impl.DDMStorageLinkModelImpl. 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 dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DDMStorageLink fetchDDMStorageLink(long storageLinkId);
/**
* Returns the ddm storage link with the matching UUID and company.
*
* @param uuid the ddm storage link's UUID
* @param companyId the primary key of the company
* @return the matching ddm storage link, or null if a matching ddm storage link could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DDMStorageLink fetchDDMStorageLinkByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DDMStorageLink getClassStorageLink(long classPK)
throws PortalException;
/**
* Returns the ddm storage link with the primary key.
*
* @param storageLinkId the primary key of the ddm storage link
* @return the ddm storage link
* @throws PortalException if a ddm storage link with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DDMStorageLink getDDMStorageLink(long storageLinkId)
throws PortalException;
/**
* Returns the ddm storage link with the matching UUID and company.
*
* @param uuid the ddm storage link's UUID
* @param companyId the primary key of the company
* @return the matching ddm storage link
* @throws PortalException if a matching ddm storage link could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DDMStorageLink getDDMStorageLinkByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the ddm storage links.
*
*
* 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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.dynamic.data.mapping.model.impl.DDMStorageLinkModelImpl. 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 ddm storage links
* @param end the upper bound of the range of ddm storage links (not inclusive)
* @return the range of ddm storage links
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDDMStorageLinks(int start, int end);
/**
* Returns the number of ddm storage links.
*
* @return the number of ddm storage links
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDDMStorageLinksCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DDMStorageLink getStorageLink(long storageLinkId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getStructureStorageLinks(long structureId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getStructureStorageLinksCount(long structureId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getStructureVersionStorageLinks(
long structureVersionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getStructureVersionStorageLinksCount(long structureVersionId);
/**
* Updates the ddm storage link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param ddmStorageLink the ddm storage link
* @return the ddm storage link that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public DDMStorageLink updateDDMStorageLink(DDMStorageLink ddmStorageLink);
public DDMStorageLink updateStorageLink(
long storageLinkId, long classNameId, long classPK)
throws PortalException;
}