Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.modeshape.graph.request
Class ChangeRequest

    java.lang.Object
      org.modeshape.graph.request.Request
          org.modeshape.graph.request.ChangeRequest

All Implemented Interfaces:
  Serializable, Cloneable

Direct Known Subclasses:
  CloneBranchRequest, CloneWorkspaceRequest, CopyBranchRequest, CreateNodeRequest, CreateWorkspaceRequest, DeleteBranchRequest, DeleteChildrenRequest, DestroyWorkspaceRequest, LockBranchRequest, MoveBranchRequest, RemovePropertyRequest, RenameNodeRequest, SetPropertyRequest, UnlockBranchRequest, UpdatePropertiesRequest, UpdateValuesRequest

    public abstract class ChangeRequest

extends Request
implements Cloneable

A Request to make changes in a graph.

See Also:
  Serialized Form

Constructor Summary
`protected` | `ChangeRequest()`

Method Summary
`abstract Location` | `changedLocation()` Get the location of the top-most node that is to be changed by this request.
`abstract String` | `changedWorkspace()` Get the name of the workspace that was changed by this request.
`abstract boolean` | `changes(String workspace, Path path)` Determine if this request changes the branch at the given path.
`abstract ChangeRequest` | `clone()` This method does not clone the results.

Methods inherited from class org.modeshape.graph.request.Request
`cancel, checkNotFrozen, freeze, getError, getType, hasError, isCancelled, isFrozen, isReadOnly, printable, printable, setError, setLatchForFreezing`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ChangeRequest

    protected ChangeRequest()

Method Detail

### changes

    public abstract boolean changes(String workspace,
                                    Path path)

  Determine if this request changes the branch at the given path.

  Parameters:
    `workspace` - the name of the workspace; may not be null
    `path` - the path; may not be null
  Returns:
    true if this request changes a node under the given path

### changedLocation

    public abstract Location changedLocation()

  Get the location of the top-most node that is to be changed by this request. If this request has been completed, this location will always have a `path`.

  Returns:
    the location changed by this request

### changedWorkspace

    public abstract String changedWorkspace()

  Get the name of the workspace that was changed by this request.

  Returns:
    the name of the workspace changed by this request

### clone

    public abstract ChangeRequest clone()

  This method does not clone the results.

  Overrides:
    `clone` in class `Object`
  See Also:
    `Object.clone()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2011 JBoss, a division of Red Hat. All Rights Reserved.