|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PathWorkspace
Method Summary | |
---|---|
Path |
getLowestExistingPath(Path path)
Find the lowest existing node along the path. |
String |
getName()
Returns the name of the workspace. |
PathNode |
getNode(Path path)
Returns the node at the given path, if one exists of null if no exists at the given
path. |
void |
lockNode(PathNode node,
LockBranchRequest.LockScope lockScope,
long lockTimeoutInMillis)
Attempts to lock the given node with the given timeout. |
QueryResults |
query(ExecutionContext context,
AccessQueryRequest accessQuery)
Perform a query of this workspace. |
QueryResults |
search(ExecutionContext context,
String fullTextSearchExpression)
Perform a full-text search of this workspace. |
void |
unlockNode(PathNode node)
Attempts to unlock the given node. |
Method Detail |
---|
String getName()
PathNode getNode(Path path)
null
if no exists at the given
path.
path
- the path of the node to retrieve; may not be null
null
if no exists at the given
path.void lockNode(PathNode node, LockBranchRequest.LockScope lockScope, long lockTimeoutInMillis) throws LockFailedException
LockFailedException
will be
thrown.
node
- the node to be locked; may not be nulllockScope
- the scope of the lock (i.e., whether descendants of node
should be included in the locklockTimeoutInMillis
- the maximum lifetime of the lock in milliseconds; zero (0) indicates that the connector default
should be used
LockFailedException
- if the implementing connector supports locking but the lock could not be acquired.void unlockNode(PathNode node)
node
- the node to be unlocked; may not be nullPath getLowestExistingPath(Path path)
path
- the path to the node; may not be null
QueryResults query(ExecutionContext context, AccessQueryRequest accessQuery)
context
- the context in which the query is to be executed; may not be nullaccessQuery
- the access query; may not be null
QueryResults search(ExecutionContext context, String fullTextSearchExpression)
context
- the context in which the query is to be executed; may not be nullfullTextSearchExpression
- the full-text search expression; may not be null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |