Milyn-Smooks Version 0.4

org.milyn.delivery
Interface ContentDeliveryUnit

All Known Subinterfaces:
AssemblyUnit, ElementVisitor, SerializationUnit, TransUnit, TransUnitPrototype
All Known Implementing Classes:
AbstractAssemblyUnit, AbstractSerializationUnit, AbstractTransUnit, HeaderAction, ParameterDecoder, ServletResponseWrapper

public interface ContentDeliveryUnit

Content Delivery Unit interface definition.

Base interface for all content delivery components. See extending interfaces.

This interface defines 2 methods for accessing descriptive information on the content delivery unit:

All implementations must contain a public constructor that takes a CDRDef instance as a parameter.

Author:
tfennelly

Method Summary
 java.lang.String getDetailDescription()
          Get a detail (more verbose) description of the Content Delivery Unit and what it does.
 java.lang.String getShortDescription()
          Get a short description of the Content Delivery Unit and what it does.
 

Method Detail

getShortDescription

public java.lang.String getShortDescription()
Get a short description of the Content Delivery Unit and what it does.

This description will be used as the short description text in UI tools.
Example: "Unclose EMPTY Element"

Note: Implementations of this method should declare this string statically.

Returns:
Short description String.
See Also:
getDetailDescription()

getDetailDescription

public java.lang.String getDetailDescription()
Get a detail (more verbose) description of the Content Delivery Unit and what it does.

This description will be used as the detail description text in UI tools.
Example: "Replace element with an unclosed (badly formed!) equivalent if the element contains no content i.e. is empty. This is required by some older useragents."

Note: Implementations of this method should declare this string statically.

Returns:
Detail description String.
See Also:
getShortDescription()

Milyn-Smooks Version 0.4