org.writersforge.catalan.process.workers
Interface IWorkMetadata

All Known Implementing Classes:

DefaultWorkerInfo, WorkMetadata

public interface IWorkMetadata

Metadata manager for IWorker and BaseCommandWorker implementations. This API is useful for validating runtime parameters and producing user-friendly catalogs of properties.

Author:

jsheets

Method Summary

java.lang.String	getDescription() Retrieves a description of this worker or command.
java.lang.String	getName() Retrieves the name of this worker or command.
OptionalPropertyInfo[]	getOptionalProperties() Retrieves metadata for all optional properties for this worker or command.
PropertyInfo[]	getRequiredProperties() Retrieves metadata for all required properties for this worker or command.

Method Detail

getName

public java.lang.String getName()

Retrieves the name of this worker or command.

Returns:

worker description

getDescription

public java.lang.String getDescription()

Retrieves a description of this worker or command.

Returns:

worker description

getRequiredProperties

public PropertyInfo[] getRequiredProperties()

Retrieves metadata for all required properties for this worker or command. If no required properties exist, returns an empty array.

Returns:

required property metadata

getOptionalProperties

public OptionalPropertyInfo[] getOptionalProperties()

Retrieves metadata for all optional properties for this worker or command. If no optional properties exist, returns an empty array.

Returns:

optional property metadata