|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.ShardLocalServiceUtil
public class ShardLocalServiceUtil
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.
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.
ShardLocalService
,
ShardLocalServiceBaseImpl
,
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 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. |
static Shard |
updateShard(Shard shard)
Updates the shard in the database or adds it if it does not yet exist. |
static Shard |
updateShard(Shard shard,
boolean merge)
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 |
---|
public ShardLocalServiceUtil()
Method Detail |
---|
public static Shard addShard(Shard shard) throws SystemException
shard
- the shard
SystemException
- if a system exception occurredpublic static Shard createShard(long shardId)
shardId
- the primary key for the new shard
public static Shard deleteShard(long shardId) throws PortalException, SystemException
shardId
- the primary key of the shard
PortalException
- if a shard with the primary key could not be found
SystemException
- if a system exception occurredpublic static Shard deleteShard(Shard shard) throws SystemException
shard
- the shard
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static Shard fetchShard(long shardId) throws SystemException
SystemException
public static Shard getShard(long shardId) throws PortalException, SystemException
shardId
- the primary key of the shard
PortalException
- if a shard with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public static List<Shard> getShards(int start, int end) throws SystemException
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.
start
- the lower bound of the range of shardsend
- the upper bound of the range of shards (not inclusive)
SystemException
- if a system exception occurredpublic static int getShardsCount() throws SystemException
SystemException
- if a system exception occurredpublic static Shard updateShard(Shard shard) throws SystemException
shard
- the shard
SystemException
- if a system exception occurredpublic static Shard updateShard(Shard shard, boolean merge) throws SystemException
shard
- the shardmerge
- 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.
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static Shard addShard(String className, long classPK, String name) throws SystemException
SystemException
public static Shard getShard(String className, long classPK) throws PortalException, SystemException
PortalException
SystemException
public static ShardLocalService getService()
public void setService(ShardLocalService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |