CmsLockFilter

java.lang.Object
- org.opencms.lock.CmsLockFilter

所有已实现的接口:

java.lang.Cloneable
```
public final class CmsLockFilter
extends java.lang.Object
implements java.lang.Cloneable
```
A filter to retrieve the locks.

从以下版本开始:

6.5.4

字段概要

字段
限定符和类型	字段和说明
`static CmsLockFilter`	`FILTER_ALL` To filter all locks.
`static CmsLockFilter`	`FILTER_INHERITED` To filter all inherited locks.
`static CmsLockFilter`	`FILTER_NON_INHERITED` To filter all non inherited locks.

方法概要

方法
限定符和类型	方法和说明
`java.lang.Object`	`clone()`
`CmsLockFilter`	`filterIncludeChildren()` Returns an extended filter that will extend the result to the given path and all its children.
`CmsLockFilter`	`filterIncludeParents()` Returns an extended filter that will extend the result to the given path and all its parents.
`CmsLockFilter`	`filterLockableByUser(CmsUser user)` Returns an extended filter with the given user restriction.
`CmsLockFilter`	`filterNotLockableByUser(CmsUser user)` Returns an extended filter with the given user restriction.
`CmsLockFilter`	`filterNotOwnedByUserId(CmsUUID userId)` Returns an extended filter with the given user restriction.
`CmsLockFilter`	`filterOwnedByUserId(CmsUUID userId)` Returns an extended filter with the given user restriction.
`CmsLockFilter`	`filterProject(CmsUUID projectId)` Returns an extended filter with the given project restriction.
`CmsLockFilter`	`filterSharedExclusive()` Returns an extended filter that also matches shared exclusive locks (siblings).
`CmsLockFilter`	`filterType(CmsLockType type)` Returns an extended filter with the given type restriction.
`CmsUser`	`getLockableByUserId()` Returns the user that can overwrite the locks.
`CmsUser`	`getNotLockableByUserId()` Returns the user that can not overwrite the locks.
`CmsUUID`	`getNotOwnedByUserId()` Returns the user that has not to own the locks.
`CmsUUID`	`getOwnedByUserId()` Returns the user that has to own the locks.
`CmsUUID`	`getProjectId()` Returns the project restriction.
`java.util.Set<CmsLockType>`	`getTypes()` Returns the types to filter.
`boolean`	`isIncludeChildren()` Returns the include children flag.
`boolean`	`isIncludeParent()` Returns the include parents flag.
`boolean`	`isSharedExclusive()` Returns the `true` if this filter also matches shared exclusive locks.
`boolean`	`match(java.lang.String rootPath, CmsLock lock)` Matches the given lock against this filter and the given path.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - FILTER_ALL
```
public static final CmsLockFilter FILTER_ALL
```
    To filter all locks.
  - FILTER_INHERITED
```
public static final CmsLockFilter FILTER_INHERITED
```
    To filter all inherited locks.
  - FILTER_NON_INHERITED
```
public static final CmsLockFilter FILTER_NON_INHERITED
```
    To filter all non inherited locks.
- 方法详细资料
  - clone
```
public java.lang.Object clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
    
    另请参阅:
    Object.clone()
  - filterNotOwnedByUserId
```
public CmsLockFilter filterNotOwnedByUserId(CmsUUID userId)
```
    Returns an extended filter with the given user restriction.
    
    参数:
    userId - the user id to filter
    
    返回:
    an extended filter with the given user restriction
  - filterNotLockableByUser
```
public CmsLockFilter filterNotLockableByUser(CmsUser user)
```
    Returns an extended filter with the given user restriction.
    
    参数:
    user - the user to filter
    
    返回:
    an extended filter with the given user restriction
  - filterLockableByUser
```
public CmsLockFilter filterLockableByUser(CmsUser user)
```
    Returns an extended filter with the given user restriction.
    
    参数:
    user - the user to filter
    
    返回:
    an extended filter with the given user restriction
  - filterIncludeChildren
```
public CmsLockFilter filterIncludeChildren()
```
    Returns an extended filter that will extend the result to the given path and all its children.
    
    返回:
    an extended filter to search the subresources of the given path
  - filterOwnedByUserId
```
public CmsLockFilter filterOwnedByUserId(CmsUUID userId)
```
    Returns an extended filter with the given user restriction.
    
    参数:
    userId - the user id to filter
    
    返回:
    an extended filter with the given user restriction
  - filterIncludeParents
```
public CmsLockFilter filterIncludeParents()
```
    Returns an extended filter that will extend the result to the given path and all its parents.
    
    返回:
    an extended filter to search the subresources of the given path
  - filterProject
```
public CmsLockFilter filterProject(CmsUUID projectId)
```
    Returns an extended filter with the given project restriction.
    
    参数:
    projectId - the project to filter the locks with
    
    返回:
    an extended filter with the given project restriction
  - filterSharedExclusive
```
public CmsLockFilter filterSharedExclusive()
```
    Returns an extended filter that also matches shared exclusive locks (siblings).
    
    返回:
    an extended filter that also matches shared exclusive locks
  - filterType
```
public CmsLockFilter filterType(CmsLockType type)
```
    Returns an extended filter with the given type restriction.
    
    参数:
    type - the lock type to filter
    
    返回:
    an extended filter with the given type restriction
  - getOwnedByUserId
```
public CmsUUID getOwnedByUserId()
```
    Returns the user that has to own the locks.
    
    返回:
    the user that has to own the locks
  - getNotOwnedByUserId
```
public CmsUUID getNotOwnedByUserId()
```
    Returns the user that has not to own the locks.
    
    返回:
    the user that has not to own the locks
  - getLockableByUserId
```
public CmsUser getLockableByUserId()
```
    Returns the user that can overwrite the locks.
    
    返回:
    the user that can overwrite the locks
  - getNotLockableByUserId
```
public CmsUser getNotLockableByUserId()
```
    Returns the user that can not overwrite the locks.
    
    返回:
    the user that can not overwrite the locks
  - getProjectId
```
public CmsUUID getProjectId()
```
    Returns the project restriction.
    
    返回:
    the project restriction
  - getTypes
```
public java.util.Set<CmsLockType> getTypes()
```
    Returns the types to filter.
    
    返回:
    the types to filter
  - isIncludeChildren
```
public boolean isIncludeChildren()
```
    Returns the include children flag.
    
    返回:
    if set the filter extends the result to the given path and all its children
  - isIncludeParent
```
public boolean isIncludeParent()
```
    Returns the include parents flag.
    
    返回:
    if set the filter extends the result to the given path and all its parents
  - isSharedExclusive
```
public boolean isSharedExclusive()
```
    Returns the true if this filter also matches shared exclusive locks.
    
    返回:
    the true if this filter also matches shared exclusive locks
  - match
```
public boolean match(java.lang.String rootPath,
            CmsLock lock)
```
    Matches the given lock against this filter and the given path.
    
    参数:
    rootPath - the path to match the lock against
    lock - the lock to match
    
    返回:
    true if the given lock matches
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()

类 CmsLockFilter

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

FILTER_ALL

FILTER_INHERITED

FILTER_NON_INHERITED

方法详细资料

clone

filterNotOwnedByUserId

filterNotLockableByUser

filterLockableByUser

filterIncludeChildren

filterOwnedByUserId

filterIncludeParents

filterProject

filterSharedExclusive

filterType

getOwnedByUserId

getNotOwnedByUserId

getLockableByUserId

getNotLockableByUserId

getProjectId

getTypes

isIncludeChildren

isIncludeParent

isSharedExclusive

match

toString