com.liferay.portal.service.persistence.ServiceComponentPersistence Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 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.portal.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.model.ServiceComponent;
/**
* The persistence interface for the service component service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see ServiceComponentPersistenceImpl
* @see ServiceComponentUtil
* @generated
*/
@ProviderType
public interface ServiceComponentPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link ServiceComponentUtil} to access the service component persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the service components where buildNamespace = ?.
*
* @param buildNamespace the build namespace
* @return the matching service components
* @throws SystemException if a system exception occurred
*/
public java.util.List findByBuildNamespace(
java.lang.String buildNamespace)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the service components where buildNamespace = ?.
*
*
* 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 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ServiceComponentModelImpl}. 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 buildNamespace the build namespace
* @param start the lower bound of the range of service components
* @param end the upper bound of the range of service components (not inclusive)
* @return the range of matching service components
* @throws SystemException if a system exception occurred
*/
public java.util.List findByBuildNamespace(
java.lang.String buildNamespace, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the service components where buildNamespace = ?.
*
*
* 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 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ServiceComponentModelImpl}. 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 buildNamespace the build namespace
* @param start the lower bound of the range of service components
* @param end the upper bound of the range of service components (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching service components
* @throws SystemException if a system exception occurred
*/
public java.util.List findByBuildNamespace(
java.lang.String buildNamespace, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first service component in the ordered set where buildNamespace = ?.
*
* @param buildNamespace the build namespace
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching service component
* @throws com.liferay.portal.NoSuchServiceComponentException if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent findByBuildNamespace_First(
java.lang.String buildNamespace,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first service component in the ordered set where buildNamespace = ?.
*
* @param buildNamespace the build namespace
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching service component, or null if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent fetchByBuildNamespace_First(
java.lang.String buildNamespace,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last service component in the ordered set where buildNamespace = ?.
*
* @param buildNamespace the build namespace
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching service component
* @throws com.liferay.portal.NoSuchServiceComponentException if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent findByBuildNamespace_Last(
java.lang.String buildNamespace,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last service component in the ordered set where buildNamespace = ?.
*
* @param buildNamespace the build namespace
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching service component, or null if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent fetchByBuildNamespace_Last(
java.lang.String buildNamespace,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the service components before and after the current service component in the ordered set where buildNamespace = ?.
*
* @param serviceComponentId the primary key of the current service component
* @param buildNamespace the build namespace
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next service component
* @throws com.liferay.portal.NoSuchServiceComponentException if a service component with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent[] findByBuildNamespace_PrevAndNext(
long serviceComponentId, java.lang.String buildNamespace,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the service components where buildNamespace = ? from the database.
*
* @param buildNamespace the build namespace
* @throws SystemException if a system exception occurred
*/
public void removeByBuildNamespace(java.lang.String buildNamespace)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of service components where buildNamespace = ?.
*
* @param buildNamespace the build namespace
* @return the number of matching service components
* @throws SystemException if a system exception occurred
*/
public int countByBuildNamespace(java.lang.String buildNamespace)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the service component where buildNamespace = ? and buildNumber = ? or throws a {@link com.liferay.portal.NoSuchServiceComponentException} if it could not be found.
*
* @param buildNamespace the build namespace
* @param buildNumber the build number
* @return the matching service component
* @throws com.liferay.portal.NoSuchServiceComponentException if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent findByBNS_BNU(
java.lang.String buildNamespace, long buildNumber)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the service component where buildNamespace = ? and buildNumber = ? or returns null if it could not be found. Uses the finder cache.
*
* @param buildNamespace the build namespace
* @param buildNumber the build number
* @return the matching service component, or null if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent fetchByBNS_BNU(
java.lang.String buildNamespace, long buildNumber)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the service component where buildNamespace = ? and buildNumber = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param buildNamespace the build namespace
* @param buildNumber the build number
* @param retrieveFromCache whether to use the finder cache
* @return the matching service component, or null if a matching service component could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent fetchByBNS_BNU(
java.lang.String buildNamespace, long buildNumber,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the service component where buildNamespace = ? and buildNumber = ? from the database.
*
* @param buildNamespace the build namespace
* @param buildNumber the build number
* @return the service component that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent removeByBNS_BNU(
java.lang.String buildNamespace, long buildNumber)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of service components where buildNamespace = ? and buildNumber = ?.
*
* @param buildNamespace the build namespace
* @param buildNumber the build number
* @return the number of matching service components
* @throws SystemException if a system exception occurred
*/
public int countByBNS_BNU(java.lang.String buildNamespace, long buildNumber)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the service component in the entity cache if it is enabled.
*
* @param serviceComponent the service component
*/
public void cacheResult(
com.liferay.portal.model.ServiceComponent serviceComponent);
/**
* Caches the service components in the entity cache if it is enabled.
*
* @param serviceComponents the service components
*/
public void cacheResult(
java.util.List serviceComponents);
/**
* Creates a new service component with the primary key. Does not add the service component to the database.
*
* @param serviceComponentId the primary key for the new service component
* @return the new service component
*/
public com.liferay.portal.model.ServiceComponent create(
long serviceComponentId);
/**
* Removes the service component with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param serviceComponentId the primary key of the service component
* @return the service component that was removed
* @throws com.liferay.portal.NoSuchServiceComponentException if a service component with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent remove(
long serviceComponentId)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.ServiceComponent updateImpl(
com.liferay.portal.model.ServiceComponent serviceComponent)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the service component with the primary key or throws a {@link com.liferay.portal.NoSuchServiceComponentException} if it could not be found.
*
* @param serviceComponentId the primary key of the service component
* @return the service component
* @throws com.liferay.portal.NoSuchServiceComponentException if a service component with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent findByPrimaryKey(
long serviceComponentId)
throws com.liferay.portal.NoSuchServiceComponentException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the service component with the primary key or returns null if it could not be found.
*
* @param serviceComponentId the primary key of the service component
* @return the service component, or null if a service component with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.ServiceComponent fetchByPrimaryKey(
long serviceComponentId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the service components.
*
* @return the service components
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the service components.
*
*
* 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 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ServiceComponentModelImpl}. 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 service components
* @param end the upper bound of the range of service components (not inclusive)
* @return the range of service components
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns an ordered range of all the service components.
*
*
* 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 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ServiceComponentModelImpl}. 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 service components
* @param end the upper bound of the range of service components (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of service components
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the service components from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of service components.
*
* @return the number of service components
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}