DocumentedResourceHandler

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

AbstractBaseResourceHandler, com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler, AbstractConfigBasedClassicHandler, AbstractResourceHandler, AbstractSearchResourceHandler, ApiHandler, AssignedCouponHandler, AssignedPromotionCodeHandler, AssociatedPromotionHandler, CartHandler, CatalogEntryHandler, CatalogHandler, CategoryHandler, ConfigurationHandler, CouponHandler, DisplayPriceHandler, ESpotDataHandler, EventHandler, GeoNodeHandler, GuestIdentityHandler, InventoryHandler, LoginIdentityHandler, LTPAIdentityHandler, OrderHandler, PageHandler, PaymentInstructionHandler, PersonCheckoutProfileHandler, PersonContactHandler, PersonHandler, PreviewTokenHandler, PriceHandler, PromotionHandler, SegmentHandler, ShippingInfoHandler, SiteContentHandler, SpotHandler, StoreHandler, StoreLocatorHandler, UserContextHandler, WishlistHandler
```
public interface DocumentedResourceHandler
```
Interface used by resource handlers that can be self-documented.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM Copyright notice field.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.apache.commons.json.JSONObject`	`documentApi(java.lang.String urlContextRoot, AbstractBaseResourceHandler executionHandler, java.util.Map<java.lang.String,java.lang.String> bundle, java.util.Locale locale)` Request the documentation of all the APIs contained within the resource handler.
`java.lang.String`	`getClassDescription(java.util.Locale locale)` Get the class description based on description annotations.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - documentApi
```
org.apache.commons.json.JSONObject documentApi(java.lang.String urlContextRoot,
                                               AbstractBaseResourceHandler executionHandler,
                                               java.util.Map<java.lang.String,java.lang.String> bundle,
                                               java.util.Locale locale)
                                        throws java.lang.Exception
```
    Request the documentation of all the APIs contained within the resource handler.
    
    Parameters:
    
    urlContextRoot - the API URL context root.
    
    executionHandler - the resource handler currently executing the request.
    
    bundle - The resource bundle to generate.
    
    locale - The locale to use.
    
    Returns:
    
    A JSONObject containing all the API meta-data.
    
    Throws:
    
    java.lang.Exception - if anything goes wrong.
  - getClassDescription
```
java.lang.String getClassDescription(java.util.Locale locale)
```
    Get the class description based on description annotations.
    
    Parameters:
    
    locale - The locale to use.
    
    Returns:
    
    The class description.