com.liferay.portal.service
Class ShardLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.ShardLocalServiceUtil

public class ShardLocalServiceUtil
extends Object

The utility for the shard local service. This utility wraps ShardLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to ShardLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. 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.

See Also:

ShardLocalService, ShardLocalServiceBaseImpl, ShardLocalServiceImpl

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

Constructor Summary

ShardLocalServiceUtil()

Method Summary

static Shard	addShard(Shard shard) Adds the shard to the database.
static Shard	addShard(String className, long classPK, String name)
static Shard	createShard(long shardId) Creates a new shard with the primary key.
static void	deleteShard(long shardId) Deletes the shard with the primary key from the database.
static void	deleteShard(Shard shard) Deletes the shard from the database.
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
static ShardLocalService	getService()
static Shard	getShard(long shardId) Gets the shard with the primary key.
static Shard	getShard(String className, long classPK)
static List<Shard>	getShards(int start, int end) Gets a range of all the shards.
static int	getShardsCount() Gets the number of shards.
void	setService(ShardLocalService service)
static Shard	updateShard(Shard shard) Updates the shard in the database.
static Shard	updateShard(Shard shard, boolean merge) Updates the shard in the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShardLocalServiceUtil

public ShardLocalServiceUtil()

Method Detail

addShard

public static Shard addShard(Shard shard)
                      throws SystemException

Adds the shard to the database. Also notifies the appropriate model listeners.

Parameters:

shard - the shard to add

Returns:

the shard that was added

Throws:

SystemException - if a system exception occurred

createShard

public static Shard createShard(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

deleteShard

public static void deleteShard(long shardId)
                        throws PortalException,
                               SystemException

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

Parameters:

shardId - the primary key of the shard to delete

Throws:

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

SystemException - if a system exception occurred

deleteShard

public static void deleteShard(Shard shard)
                        throws SystemException

Deletes the shard from the database. Also notifies the appropriate model listeners.

Parameters:

shard - the shard to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getShard

public static Shard getShard(long shardId)
                      throws PortalException,
                             SystemException

Gets the shard with the primary key.

Parameters:

shardId - the primary key of the shard to get

Returns:

the shard

Throws:

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

SystemException - if a system exception occurred

getShards

public static List<Shard> getShards(int start,
                                    int end)
                             throws SystemException

Gets 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

getShardsCount

public static int getShardsCount()
                          throws SystemException

Gets the number of shards.

Returns:

the number of shards

Throws:

SystemException - if a system exception occurred

updateShard

public static Shard updateShard(Shard shard)
                         throws SystemException

Updates the shard in the database. Also notifies the appropriate model listeners.

Parameters:

shard - the shard to update

Returns:

the shard that was updated

Throws:

SystemException - if a system exception occurred

updateShard

public static Shard updateShard(Shard shard,
                                boolean merge)
                         throws SystemException

Updates the shard in the database. Also notifies the appropriate model listeners.

Parameters:

shard - the shard to update

merge - whether to merge the shard with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the shard that was updated

Throws:

SystemException - if a system exception occurred

addShard

public static Shard addShard(String className,
                             long classPK,
                             String name)
                      throws SystemException

Throws:

SystemException

getShard

public static Shard getShard(String className,
                             long classPK)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getService

public static ShardLocalService getService()

setService

public void setService(ShardLocalService service)