com.liferay.portal.service
Class ShardLocalServiceUtil

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

@ProviderType
public class ShardLocalServiceUtil
extends Object

Provides the local service utility for Shard. This utility wraps com.liferay.portal.service.impl.ShardLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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, com.liferay.portal.service.impl.ShardLocalServiceImpl

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 Shard	deleteShard(long shardId) Deletes the shard with the primary key from the database.
static Shard	deleteShard(Shard shard) Deletes the shard from the database.
static DynamicQuery	dynamicQuery()
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) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static Shard	fetchShard(long shardId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ShardLocalService	getService()
static Shard	getShard(long shardId) Returns the shard with the primary key.
static Shard	getShard(String className, long classPK)
static List<Shard>	getShards(int start, int end) Returns a range of all the shards.
static int	getShardsCount() Returns the number of shards.
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(ShardLocalService service) Deprecated. As of 6.2.0
static Shard	updateShard(Shard shard) Updates the shard in the database or adds it if it does not yet exist.

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

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 Shard 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

Returns:

the shard that was removed

Throws:

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

SystemException - if a system exception occurred

deleteShard

public static Shard deleteShard(Shard shard)
                         throws SystemException

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

Parameters:

shard - the shard

Returns:

the shard that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

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

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchShard

public static Shard fetchShard(long shardId)
                        throws SystemException

Throws:

SystemException

getShard

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

Returns the shard with the primary key.

Parameters:

shardId - the primary key of the shard

Returns:

the shard

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getShards

public static List<Shard> getShards(int start,
                                    int end)
                             throws 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

start - the lower bound of the range of shards

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

Returns:

the range of shards

Throws:

SystemException - if a system exception occurred

getShardsCount

public static int getShardsCount()
                          throws SystemException

Returns 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 or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

shard - the shard

Returns:

the shard that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

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)

Deprecated. As of 6.2.0