Liferay 7.0-ce-m6

com.liferay.portal.service
Interface ShardLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ShardLocalServiceBaseImpl, ShardLocalServiceImpl, ShardLocalServiceWrapper

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

Provides the local service interface for Shard. 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.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 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()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 Shard fetchShard(long shardId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 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.
 

Method Detail

addShard

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

addShard

@Indexable(type=REINDEX)
Shard addShard(Shard shard)
Adds the shard to the database. Also notifies the appropriate model listeners.

Parameters:
shard - the shard
Returns:
the shard that was added

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteShard

@Indexable(type=DELETE)
Shard deleteShard(Shard shard)
Deletes the shard from the database. Also notifies the appropriate model listeners.

Parameters:
shard - the shard
Returns:
the shard that was removed

deleteShard

@Indexable(type=DELETE)
Shard deleteShard(long shardId)
                  throws PortalException
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

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
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

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)
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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchShard

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getShard

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

getShard

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Shard getShard(long shardId)
               throws PortalException
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

getShards

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Shard> getShards(int start,
                                                               int end)
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

getShardsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShardsCount()
Returns the number of shards.

Returns:
the number of shards

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateShard

@Indexable(type=REINDEX)
Shard updateShard(Shard shard)
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

Liferay 7.0-ce-m6