com.liferay.portal.service.persistence.ShardPersistence 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.Shard;
/**
* The persistence interface for the shard service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see ShardPersistenceImpl
* @see ShardUtil
* @generated
*/
@ProviderType
public interface ShardPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link ShardUtil} to access the shard persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns the shard where name = ? or throws a {@link com.liferay.portal.NoSuchShardException} if it could not be found.
*
* @param name the name
* @return the matching shard
* @throws com.liferay.portal.NoSuchShardException if a matching shard could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard findByName(java.lang.String name)
throws com.liferay.portal.NoSuchShardException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard where name = ? or returns null if it could not be found. Uses the finder cache.
*
* @param name the name
* @return the matching shard, or null if a matching shard could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard fetchByName(java.lang.String name)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard where name = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param name the name
* @param retrieveFromCache whether to use the finder cache
* @return the matching shard, or null if a matching shard could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard fetchByName(java.lang.String name,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the shard where name = ? from the database.
*
* @param name the name
* @return the shard that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard removeByName(java.lang.String name)
throws com.liferay.portal.NoSuchShardException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of shards where name = ?.
*
* @param name the name
* @return the number of matching shards
* @throws SystemException if a system exception occurred
*/
public int countByName(java.lang.String name)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard where classNameId = ? and classPK = ? or throws a {@link com.liferay.portal.NoSuchShardException} if it could not be found.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @return the matching shard
* @throws com.liferay.portal.NoSuchShardException if a matching shard could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard findByC_C(long classNameId,
long classPK)
throws com.liferay.portal.NoSuchShardException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard where classNameId = ? and classPK = ? or returns null if it could not be found. Uses the finder cache.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @return the matching shard, or null if a matching shard could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard fetchByC_C(long classNameId,
long classPK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard where classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @param retrieveFromCache whether to use the finder cache
* @return the matching shard, or null if a matching shard could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard fetchByC_C(long classNameId,
long classPK, boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the shard where classNameId = ? and classPK = ? from the database.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @return the shard that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard removeByC_C(long classNameId,
long classPK)
throws com.liferay.portal.NoSuchShardException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of shards where classNameId = ? and classPK = ?.
*
* @param classNameId the class name ID
* @param classPK the class p k
* @return the number of matching shards
* @throws SystemException if a system exception occurred
*/
public int countByC_C(long classNameId, long classPK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the shard in the entity cache if it is enabled.
*
* @param shard the shard
*/
public void cacheResult(com.liferay.portal.model.Shard shard);
/**
* Caches the shards in the entity cache if it is enabled.
*
* @param shards the shards
*/
public void cacheResult(
java.util.List shards);
/**
* Creates a new shard with the primary key. Does not add the shard to the database.
*
* @param shardId the primary key for the new shard
* @return the new shard
*/
public com.liferay.portal.model.Shard create(long shardId);
/**
* Removes the shard with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param shardId the primary key of the shard
* @return the shard that was removed
* @throws com.liferay.portal.NoSuchShardException if a shard with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard remove(long shardId)
throws com.liferay.portal.NoSuchShardException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Shard updateImpl(
com.liferay.portal.model.Shard shard)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard with the primary key or throws a {@link com.liferay.portal.NoSuchShardException} if it could not be found.
*
* @param shardId the primary key of the shard
* @return the shard
* @throws com.liferay.portal.NoSuchShardException if a shard with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard findByPrimaryKey(long shardId)
throws com.liferay.portal.NoSuchShardException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the shard with the primary key or returns null if it could not be found.
*
* @param shardId the primary key of the shard
* @return the shard, or null if a shard with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Shard fetchByPrimaryKey(long shardId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the shards.
*
* @return the shards
* @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 shards.
*
*
* 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.ShardModelImpl}. 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 shards
* @param end the upper bound of the range of shards (not inclusive)
* @return the range of shards
* @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 shards.
*
*
* 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.ShardModelImpl}. 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 shards
* @param end the upper bound of the range of shards (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of shards
* @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 shards from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of shards.
*
* @return the number of shards
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}