com.liferay.portal.service.persistence
Interface ShardPersistence

All Superinterfaces:

BasePersistence<Shard>

All Known Implementing Classes:

ShardPersistenceImpl

public interface ShardPersistence
extends BasePersistence<Shard>

The persistence interface for the shard service.

Never modify or reference this interface directly. Always use ShardUtil to access the shard persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:

ShardPersistenceImpl, ShardUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	cacheResult(List<Shard> shards) Caches the shards in the entity cache if it is enabled.
void	cacheResult(Shard shard) Caches the shard in the entity cache if it is enabled.
int	countAll() Counts all the shards.
int	countByC_C(long classNameId, long classPK) Counts all the shards where classNameId = ? and classPK = ?.
int	countByName(String name) Counts all the shards where name = ?.
Shard	create(long shardId) Creates a new shard with the primary key.
Shard	fetchByC_C(long classNameId, long classPK) Finds the shard where classNameId = ? and classPK = ? or returns null if it could not be found.
Shard	fetchByC_C(long classNameId, long classPK, boolean retrieveFromCache) Finds the shard where classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.
Shard	fetchByName(String name) Finds the shard where name = ? or returns null if it could not be found.
Shard	fetchByName(String name, boolean retrieveFromCache) Finds the shard where name = ? or returns null if it could not be found, optionally using the finder cache.
Shard	fetchByPrimaryKey(long shardId) Finds the shard with the primary key or returns null if it could not be found.
List<Shard>	findAll() Finds all the shards.
List<Shard>	findAll(int start, int end) Finds a range of all the shards.
List<Shard>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the shards.
Shard	findByC_C(long classNameId, long classPK) Finds the shard where classNameId = ? and classPK = ? or throws a NoSuchShardException if it could not be found.
Shard	findByName(String name) Finds the shard where name = ? or throws a NoSuchShardException if it could not be found.
Shard	findByPrimaryKey(long shardId) Finds the shard with the primary key or throws a NoSuchShardException if it could not be found.
Shard	remove(long shardId) Removes the shard with the primary key from the database.
void	removeAll() Removes all the shards from the database.
void	removeByC_C(long classNameId, long classPK) Removes the shard where classNameId = ? and classPK = ? from the database.
void	removeByName(String name) Removes the shard where name = ? from the database.
Shard	updateImpl(Shard shard, boolean merge)

Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence

clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update

Method Detail

cacheResult

void cacheResult(Shard shard)

Caches the shard in the entity cache if it is enabled.

Parameters:

shard - the shard to cache

cacheResult

void cacheResult(List<Shard> shards)

Caches the shards in the entity cache if it is enabled.

Parameters:

shards - the shards to cache

create

Shard create(long shardId)

Creates a new shard with the primary key. Does not add the shard to the database.

Parameters:

shardId - the primary key for the new shard

Returns:

the new shard

remove

Shard remove(long shardId)
             throws NoSuchShardException,
                    SystemException

Removes the shard with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

shardId - the primary key of the shard to remove

Returns:

the shard that was removed

Throws:

NoSuchShardException - if a shard with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

Shard updateImpl(Shard shard,
                 boolean merge)
                 throws SystemException

Throws:

SystemException

findByPrimaryKey

Shard findByPrimaryKey(long shardId)
                       throws NoSuchShardException,
                              SystemException

Finds the shard with the primary key or throws a NoSuchShardException if it could not be found.

Parameters:

shardId - the primary key of the shard to find

Returns:

the shard

Throws:

NoSuchShardException - if a shard with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

Shard fetchByPrimaryKey(long shardId)
                        throws SystemException

Finds the shard with the primary key or returns null if it could not be found.

Parameters:

shardId - the primary key of the shard to find

Returns:

the shard, or null if a shard with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findByName

Shard findByName(String name)
                 throws NoSuchShardException,
                        SystemException

Finds the shard where name = ? or throws a NoSuchShardException if it could not be found.

Parameters:

name - the name to search with

Returns:

the matching shard

Throws:

NoSuchShardException - if a matching shard could not be found

SystemException - if a system exception occurred

fetchByName

Shard fetchByName(String name)
                  throws SystemException

Finds the shard where name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

name - the name to search with

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

fetchByName

Shard fetchByName(String name,
                  boolean retrieveFromCache)
                  throws SystemException

Finds the shard where name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

name - the name to search with

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

findByC_C

Shard findByC_C(long classNameId,
                long classPK)
                throws NoSuchShardException,
                       SystemException

Finds the shard where classNameId = ? and classPK = ? or throws a NoSuchShardException if it could not be found.

Parameters:

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the matching shard

Throws:

NoSuchShardException - if a matching shard could not be found

SystemException - if a system exception occurred

fetchByC_C

Shard fetchByC_C(long classNameId,
                 long classPK)
                 throws SystemException

Finds the shard where classNameId = ? and classPK = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

fetchByC_C

Shard fetchByC_C(long classNameId,
                 long classPK,
                 boolean retrieveFromCache)
                 throws SystemException

Finds the shard where classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the matching shard, or null if a matching shard could not be found

Throws:

SystemException - if a system exception occurred

findAll

List<Shard> findAll()
                    throws SystemException

Finds all the shards.

Returns:

the shards

Throws:

SystemException - if a system exception occurred

findAll

List<Shard> findAll(int start,
                    int end)
                    throws SystemException

Finds 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 QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of shards to return

end - the upper bound of the range of shards to return (not inclusive)

Returns:

the range of shards

Throws:

SystemException - if a system exception occurred

findAll

List<Shard> findAll(int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException

Finds 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 QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of shards to return

end - the upper bound of the range of shards to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of shards

Throws:

SystemException - if a system exception occurred

removeByName

void removeByName(String name)
                  throws NoSuchShardException,
                         SystemException

Removes the shard where name = ? from the database.

Parameters:

name - the name to search with

Throws:

SystemException - if a system exception occurred

NoSuchShardException

removeByC_C

void removeByC_C(long classNameId,
                 long classPK)
                 throws NoSuchShardException,
                        SystemException

Removes the shard where classNameId = ? and classPK = ? from the database.

Parameters:

classNameId - the class name id to search with

classPK - the class p k to search with

Throws:

SystemException - if a system exception occurred

NoSuchShardException

removeAll

void removeAll()
               throws SystemException

Removes all the shards from the database.

Throws:

SystemException - if a system exception occurred

countByName

int countByName(String name)
                throws SystemException

Counts all the shards where name = ?.

Parameters:

name - the name to search with

Returns:

the number of matching shards

Throws:

SystemException - if a system exception occurred

countByC_C

int countByC_C(long classNameId,
               long classPK)
               throws SystemException

Counts all the shards where classNameId = ? and classPK = ?.

Parameters:

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the number of matching shards

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Counts all the shards.

Returns:

the number of shards

Throws:

SystemException - if a system exception occurred