|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME)
public @interface RestCommandDocumentation
Annotation used to describe the expected input to a RestCommand. This should be formatted in WADL XML format, which describes command methods as well as parameters that are accepted by RestCommand, including restrictions on those parameters. This annotation will be consumed by a documentation tool that will be used to generate documentation for all RestCommands in the system.
Annotation Type Required Member Summary | |
---|---|
String |
inputDescription |
String |
resultType |
Annotation Type Optional Member Summary | |
---|---|
String |
commandName |
String |
descriptionText |
String |
errorCodes |
String |
inputExample |
String |
method |
String |
namespace |
String |
returnExample |
Annotation Type Member Detail |
---|
public abstract String inputDescription
public abstract String resultType
public abstract String descriptionText
public abstract String namespace
public abstract String commandName
public abstract String inputExample
public abstract String returnExample
public abstract String errorCodes
public abstract String method
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
Copyright © 2010, Oracle. All rights reserved.