|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.lock.CmsLockFilter
public final class CmsLockFilter
A filter to retrieve the locks.
Field Summary | |
---|---|
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. |
Method Summary | |
---|---|
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 |
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()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final CmsLockFilter FILTER_ALL
public static final CmsLockFilter FILTER_INHERITED
public static final CmsLockFilter FILTER_NON_INHERITED
Method Detail |
---|
public java.lang.Object clone()
clone
in class java.lang.Object
Object.clone()
public CmsLockFilter filterNotOwnedByUserId(CmsUUID userId)
userId
- the user id to filter
public CmsLockFilter filterNotLockableByUser(CmsUser user)
user
- the user to filter
public CmsLockFilter filterLockableByUser(CmsUser user)
user
- the user to filter
public CmsLockFilter filterIncludeChildren()
public CmsLockFilter filterOwnedByUserId(CmsUUID userId)
userId
- the user id to filter
public CmsLockFilter filterIncludeParents()
public CmsLockFilter filterProject(CmsUUID projectId)
projectId
- the project to filter the locks with
public CmsLockFilter filterSharedExclusive()
public CmsLockFilter filterType(CmsLockType type)
type
- the lock type to filter
public CmsUUID getOwnedByUserId()
public CmsUUID getNotOwnedByUserId()
public CmsUser getLockableByUserId()
public CmsUser getNotLockableByUserId()
public CmsUUID getProjectId()
public java.util.Set getTypes()
public boolean isIncludeChildren()
public boolean isIncludeParent()
public boolean isSharedExclusive()
true
if this filter also matches shared exclusive locks.
true
if this filter also matches shared exclusive lockspublic boolean match(java.lang.String rootPath, CmsLock lock)
rootPath
- the path to match the lock againstlock
- the lock to match
true
if the given lock matchespublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |