au.com.prunge.jgenfile
Interface CanSetMetadataOperation

All Superinterfaces:

ItemOperation, Operation

All Known Implementing Classes:

ConstantCanSetMetadataOperation

public interface CanSetMetadataOperation

extends ItemOperation

An operation that determines whether elements of metadata can be modified for an item.

Version:

1.0

Author:

Peter Runge

Method Summary

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

Returns:

a set of MetadataKey objects.

See Also:

MetadataKey

getModifiableMetadataSet

public Set getModifiableMetadataSet()
                             throws OperationNotFinishedException,
                                    JGenFileException

Returns the set of metadata keys that can be set 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

getNonModifiableMetadataSet

public Set getNonModifiableMetadataSet()
                                throws OperationNotFinishedException,
                                       JGenFileException

Returns the set of metadata keys that cannot be set 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