Liferay 7.0-ce-m3

com.liferay.portal.service
Class LockLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.LockLocalServiceUtil

@ProviderType
public class LockLocalServiceUtil
extends Object

Provides the local service utility for Lock. This utility wraps com.liferay.portal.service.impl.LockLocalServiceImpl 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:
LockLocalService, LockLocalServiceBaseImpl, com.liferay.portal.service.impl.LockLocalServiceImpl

Constructor Summary
LockLocalServiceUtil()
           
 
Method Summary
static Lock addLock(Lock lock)
          Adds the lock to the database.
static void clear()
           
static Lock createLock(long lockId)
          Creates a new lock with the primary key.
static Lock deleteLock(Lock lock)
          Deletes the lock from the database.
static Lock deleteLock(long lockId)
          Deletes the lock with the primary key from the database.
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<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.
static
<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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static Lock fetchLock(long lockId)
           
static Lock fetchLockByUuidAndCompanyId(String uuid, long companyId)
          Returns the lock with the matching UUID and company.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static Lock getLock(long lockId)
          Returns the lock with the primary key.
static Lock getLock(String className, long key)
           
static Lock getLock(String className, String key)
           
static Lock getLockByUuidAndCompanyId(String uuid, long companyId)
          Returns the lock with the matching UUID and company.
static List<Lock> getLocks(int start, int end)
          Returns a range of all the locks.
static int getLocksCount()
          Returns the number of locks.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static LockLocalService getService()
           
static boolean hasLock(long userId, String className, long key)
           
static boolean hasLock(long userId, String className, String key)
           
static boolean isLocked(String className, long key)
           
static boolean isLocked(String className, String key)
           
static Lock lock(long userId, String className, long key, String owner, boolean inheritable, long expirationTime)
           
static Lock lock(long userId, String className, String key, String owner, boolean inheritable, long expirationTime)
           
static Lock lock(String className, String key, String owner)
           
static Lock lock(String className, String key, String owner, boolean retrieveFromCache)
          Deprecated. As of 6.2.0, replaced by lock(String, String, String)
static Lock lock(String className, String key, String expectedOwner, String updatedOwner)
           
static Lock lock(String className, String key, String expectedOwner, String updatedOwner, boolean retrieveFromCache)
          Deprecated. As of 6.2.0, replaced by lock(String, String, String, String)
static Lock refresh(String uuid, long companyId, long expirationTime)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(LockLocalService service)
          Deprecated. As of 6.2.0
static void unlock(String className, long key)
           
static void unlock(String className, String key)
           
static void unlock(String className, String key, String owner)
           
static void unlock(String className, String key, String owner, boolean retrieveFromCache)
          Deprecated. As of 6.2.0, replaced by unlock(String, String, String)
static Lock updateLock(Lock lock)
          Updates the lock 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

LockLocalServiceUtil

public LockLocalServiceUtil()
Method Detail

addLock

public static Lock addLock(Lock lock)
Adds the lock to the database. Also notifies the appropriate model listeners.

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

clear

public static void clear()

createLock

public static Lock createLock(long lockId)
Creates a new lock with the primary key. Does not add the lock to the database.

Parameters:
lockId - the primary key for the new lock
Returns:
the new lock

deleteLock

public static Lock deleteLock(Lock lock)
Deletes the lock from the database. Also notifies the appropriate model listeners.

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

deleteLock

public static Lock deleteLock(long lockId)
                       throws PortalException
Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
lockId - the primary key of the lock
Returns:
the lock that was removed
Throws:
PortalException - if a lock with the primary key could not be found

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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 LockModelImpl. 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

public static <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 LockModelImpl. 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

public static 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

public static 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

fetchLock

public static Lock fetchLock(long lockId)

fetchLockByUuidAndCompanyId

public static Lock fetchLockByUuidAndCompanyId(String uuid,
                                               long companyId)
Returns the lock with the matching UUID and company.

Parameters:
uuid - the lock's UUID
companyId - the primary key of the company
Returns:
the matching lock, or null if a matching lock could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getLock

public static Lock getLock(String className,
                           long key)
                    throws PortalException
Throws:
PortalException

getLock

public static Lock getLock(String className,
                           String key)
                    throws PortalException
Throws:
PortalException

getLock

public static Lock getLock(long lockId)
                    throws PortalException
Returns the lock with the primary key.

Parameters:
lockId - the primary key of the lock
Returns:
the lock
Throws:
PortalException - if a lock with the primary key could not be found

getLockByUuidAndCompanyId

public static Lock getLockByUuidAndCompanyId(String uuid,
                                             long companyId)
                                      throws PortalException
Returns the lock with the matching UUID and company.

Parameters:
uuid - the lock's UUID
companyId - the primary key of the company
Returns:
the matching lock
Throws:
PortalException - if a matching lock could not be found

getLocks

public static List<Lock> getLocks(int start,
                                  int end)
Returns a range of all the locks.

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 LockModelImpl. 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 locks
end - the upper bound of the range of locks (not inclusive)
Returns:
the range of locks

getLocksCount

public static int getLocksCount()
Returns the number of locks.

Returns:
the number of locks

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

hasLock

public static boolean hasLock(long userId,
                              String className,
                              String key)

hasLock

public static boolean hasLock(long userId,
                              String className,
                              long key)

isLocked

public static boolean isLocked(String className,
                               String key)

isLocked

public static boolean isLocked(String className,
                               long key)

lock

public static Lock lock(String className,
                        String key,
                        String expectedOwner,
                        String updatedOwner)

lock

@Deprecated
public static Lock lock(String className,
                                   String key,
                                   String expectedOwner,
                                   String updatedOwner,
                                   boolean retrieveFromCache)
Deprecated. As of 6.2.0, replaced by lock(String, String, String, String)


lock

public static Lock lock(String className,
                        String key,
                        String owner)

lock

@Deprecated
public static Lock lock(String className,
                                   String key,
                                   String owner,
                                   boolean retrieveFromCache)
Deprecated. As of 6.2.0, replaced by lock(String, String, String)


lock

public static Lock lock(long userId,
                        String className,
                        String key,
                        String owner,
                        boolean inheritable,
                        long expirationTime)
                 throws PortalException
Throws:
PortalException

lock

public static Lock lock(long userId,
                        String className,
                        long key,
                        String owner,
                        boolean inheritable,
                        long expirationTime)
                 throws PortalException
Throws:
PortalException

refresh

public static Lock refresh(String uuid,
                           long companyId,
                           long expirationTime)
                    throws PortalException
Throws:
PortalException

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

unlock

public static void unlock(String className,
                          long key)

unlock

public static void unlock(String className,
                          String key)

unlock

public static void unlock(String className,
                          String key,
                          String owner)

unlock

@Deprecated
public static void unlock(String className,
                                     String key,
                                     String owner,
                                     boolean retrieveFromCache)
Deprecated. As of 6.2.0, replaced by unlock(String, String, String)


updateLock

public static Lock updateLock(Lock lock)
Updates the lock in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
lock - the lock
Returns:
the lock that was updated

getService

public static LockLocalService getService()

setService

@Deprecated
public void setService(LockLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m3