commonj.connector.metadata.discovery
Interface MetadataObjectResponse


public interface MetadataObjectResponse

Represents the response from a call to MetadataTree.listMetadataObjects(commonj.connector.metadata.discovery.properties.PropertyGroup)or MetadataObject.getChildren(commonj.connector.metadata.discovery.properties.PropertyGroup). This interface encapsulates the returned tree of MetadataObjects.

Since:
1.0
See Also:
MetadataObject

Method Summary
 String getMessage()
          Returns any status messages that may have been returned with the response.
 MetadataObjectIterator getObjectIterator()
          Returns an iterator for the content of the MetadataObjectResponse.
 

Method Detail

getObjectIterator

MetadataObjectIterator getObjectIterator()
Returns an iterator for the content of the MetadataObjectResponse.

Returns:
a non null iterator. The iterator itself may not have any content if the response contained no MetadataObjects.

getMessage

String getMessage()
Returns any status messages that may have been returned with the response. For example, if the response came back with no results there may have been a reason, such as an empty repository or the use of filter parameters that were too restrictive . If the response comes back with a very large number of results the message may indicate this and suggest modifying the filter parameters.

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

Returns:
A String message or null if no message exists.
See Also:
ResourceBundle, MessageFormat