au.com.prunge.jgenfile
Interface GetParentOperation

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

public interface GetParentOperation
extends ItemOperation

An operation that retrieves the parent directory of an item.

Version:
1.0
Author:
Peter Runge

Method Summary
 au.com.prunge.jgenfile.Directory getParent()
          Returns the parent directory acquired with this operation.
 void run()
          Runs 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, setOperationHint, setOperationHints
 

Method Detail

getParent

public au.com.prunge.jgenfile.Directory getParent()
                                           throws OperationNotFinishedException,
                                                  JGenFileException
Returns the parent directory acquired with this operation. Returns null if the source item is a root in the file system.

Returns:
the parent directory, or null if no parent directory exists.
Throws:
OperationNotFinishedException - if this method was called and the run() method has not finished or has not been called.
JGenFileException - if another error occurs.

run

public void run()
         throws JGenFileException
Runs this operation.

Specified by:
run in interface Operation
Throws:
NonexistantParentException - if the item does not have a parent.
JGenFileException - if an error occurs.
See Also:
Operation.run()