com.liferay.portal.service
Interface ShardLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ShardLocalServiceBaseImpl, ShardLocalServiceImpl, ShardLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShardLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the shard local service.

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:

ShardLocalServiceUtil, ShardLocalServiceBaseImpl, ShardLocalServiceImpl

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

Method Summary

Shard	addShard(Shard shard) Adds the shard to the database.
Shard	addShard(String className, long classPK, String name)
Shard	createShard(long shardId) Creates a new shard with the primary key.
Shard	deleteShard(long shardId) Deletes the shard with the primary key from the database.
Shard	deleteShard(Shard shard) Deletes the shard from the database.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
Shard	fetchShard(long shardId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Shard	getShard(long shardId) Returns the shard with the primary key.
Shard	getShard(String className, long classPK)
List<Shard>	getShards(int start, int end) Returns a range of all the shards.
int	getShardsCount() Returns the number of shards.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
Shard	updateShard(Shard shard) Updates the shard in the database or adds it if it does not yet exist.
Shard	updateShard(Shard shard, boolean merge) Updates the shard in the database or adds it if it does not yet exist.

Method Detail

addShard

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

fetchShard

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Shard fetchShard(long shardId)
                 throws SystemException

Throws:

SystemException

getShard

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getShards

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShardsCount()
                   throws SystemException

Returns the number of shards.

Returns:

the number of shards

Throws:

SystemException - if a system exception occurred

updateShard

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

updateShard

Shard updateShard(Shard shard,
                  boolean merge)
                  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

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

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addShard

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

Throws:

SystemException

getShard

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Shard getShard(String className,
                                                        long classPK)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException