au.com.prunge.jgenfile
Interface CanGetRelativePathOperation

All Superinterfaces:
ItemOperation, Operation
All Known Implementing Classes:
LocalCanGetRelativePathOperation

public interface CanGetRelativePathOperation
extends ItemOperation

An operation that tests whether the relative path of an item can be acquired.

Version:
1.0
Author:
Peter Runge

Method Summary
 boolean canGetRelativePath()
          Returns whether the relative path of the item can be acquired.
 au.com.prunge.jgenfile.Directory getToAncestor()
          Returns the directory that will be the most distant ancestor in the path created by this operation.
 
Methods inherited from interface au.com.prunge.jgenfile.ItemOperation
getItem
 
Methods inherited from interface au.com.prunge.jgenfile.Operation
abort, addOperationHints, getLastRunException, getOperationHint, getOperationHints, hasRun, run, setOperationHint, setOperationHints
 

Method Detail

getToAncestor

public au.com.prunge.jgenfile.Directory getToAncestor()
Returns the directory that will be the most distant ancestor in the path created by this operation.

Returns:
the most distant ancestor of the path.

canGetRelativePath

public boolean canGetRelativePath()
                           throws OperationNotFinishedException,
                                  JGenFileException
Returns whether the relative path of the item can be acquired.

Returns:
true if the path can be acquired, false if not.
Throws:
OperationNotFinishedException - if this method was called and the run() method has not finished or has not been called.
JGenFileException - if another error occurs.