au.com.prunge.jgenfile
Interface GetItemFromRelativeReferenceOperation

All Superinterfaces:

DirectoryOperation, ItemOperation, Operation

All Known Implementing Classes:

LocalGetItemFromRelativeReferenceOperation

public interface GetItemFromRelativeReferenceOperation

extends DirectoryOperation

An operation that attempts to get an item given a relative reference.

Version:

1.0

Author:

Peter Runge

Method Summary

au.com.prunge.jgenfile.Item	getItemFromReference() Returns the item acquired with the reference.
au.com.prunge.jgenfile.RelativeItemReference	getReference() Returns the reference of the item.
void	run() Runs this operation.

Methods inherited from interface au.com.prunge.jgenfile.DirectoryOperation

getDirectory

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

getReference

public au.com.prunge.jgenfile.RelativeItemReference getReference()

Returns the reference of the item.

Returns:

the reference of the item.

getItemFromReference

public au.com.prunge.jgenfile.Item getItemFromReference()
                                                 throws OperationNotFinishedException,
                                                        JGenFileException

Returns the item acquired with the reference.

Returns:

the acquired item.

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 ItemNotFoundException,
                JGenFileException

Runs this operation.

Specified by:

run in interface Operation

Throws:

ItemNotFoundException - if the item could not be found from the reference.

JGenFileException - if another error occurs.

See Also:

Operation.abort()