com.adobe.idp.dsc.registry.infomodel
Interface Fault

All Superinterfaces:

java.io.Serializable

public interface Fault
extends java.io.Serializable

A Fault object stores the metadata related to faults for a service.

Method Summary

java.lang.String	getDescription() Retrieves the description of the usage of this fault.
java.lang.String	getHint() Retrieves the short description of the purpose of this fault.
java.lang.String	getName() Retrieves the name of this fault, which is expected to be unique with respect to the operation.
java.lang.String	getTitle() Retrieves the title of this fault, which is expected to be displayed within any IDE or user interface.
java.lang.String	getType() Retrieves the name of the exception class that is expected to be thrown due to this fault.

Method Detail

getName

java.lang.String getName()

Retrieves the name of this fault, which is expected to be unique with respect to the operation.

Returns:

The name of this fault.

getTitle

java.lang.String getTitle()

Retrieves the title of this fault, which is expected to be displayed within any IDE or user interface.

Returns:

The title of this fault.

getDescription

java.lang.String getDescription()

Retrieves the description of the usage of this fault.

Returns:

The description of the usage of this fault.

getHint

java.lang.String getHint()

Retrieves the short description of the purpose of this fault.

Returns:

The short description of the purpose of this fault.

getType

java.lang.String getType()

Retrieves the name of the exception class that is expected to be thrown due to this fault.

Returns:

The exception class name.