au.com.prunge.jgenfile
Interface GetMetadataOperation

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

public interface GetMetadataOperation
extends ItemOperation

An operation that acquires metadata for an item.

Version:
1.0
Author:
Peter Runge

Method Summary
 Map getMetadata()
          Returns a map of MetadataKey objects to the values that were looked up.
 Set getMetadataKeySet()
          Returns the set of metadata keys this operation is looking up for the item.
 
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

getMetadataKeySet

public Set getMetadataKeySet()
Returns the set of metadata keys this operation is looking up for the item.

Returns:
a set of MetadataKey objects.
See Also:
MetadataKey

getMetadata

public Map getMetadata()
                throws OperationNotFinishedException,
                       JGenFileException
Returns a map of MetadataKey objects to the values that were looked up. If one or more elements of metadata could not be accessed, the corresponding key will not exist in the map.

Returns:
a map of MetadataKey objects to values.
Throws:
OperationNotFinishedException - if this method was called and the run() method has not finished or has not been called.
JGenFileException - if another error occurs.
See Also:
MetadataKey