au.com.prunge.jgenfile
Interface CanGetMetadataOperation

All Superinterfaces:

ItemOperation, Operation

All Known Implementing Classes:

LocalCanGetMetadataOperation

public interface CanGetMetadataOperation

extends ItemOperation

An operation that determines whether elements of metadata are accessible for an item.

Version:

1.0

Author:

Peter Runge

Method Summary

Set	getAccessibleMetadataKeySet() Returns the set of metadata keys that can be acquired for this item.
Set	getInaccessibleMetadataKeySet() Returns the set of metadata keys that cannot be acquired for this item.
Set	getMetadataKeySet() Returns the set of metadata keys this operation is checking for access 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 checking for access for the item.

Returns:

a set of MetadataKey objects.

See Also:

MetadataKey

getAccessibleMetadataKeySet

public Set getAccessibleMetadataKeySet()
                                throws OperationNotFinishedException,
                                       JGenFileException

Returns the set of metadata keys that can be acquired for this item.

Returns:

a set of MetadataKey objects.

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

getInaccessibleMetadataKeySet

public Set getInaccessibleMetadataKeySet()
                                  throws OperationNotFinishedException,
                                         JGenFileException

Returns the set of metadata keys that cannot be acquired for this item.

Returns:

a set of MetadataKey objects.

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