AdditionalParameterList

Skip navigation links

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface AdditionalParameterList
```
Annotation used to add parameters to a REST API method without adding them to the java method signature.

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

ParameterDescription[] value

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.Class`	`mappedClass`
`com.ibm.commerce.rest.javadoc.ClassType`	`mappedClassType`
`java.lang.String`	`mappedProfile`

- Element Detail
  - value
```
public abstract ParameterDescription[] value
```
    Returns:
    
    The list of all the additional parameters supported by the method.
- - mappedClass
```
public abstract java.lang.Class mappedClass
```
    Returns:
    
    The mapped class that will be used to provide additional parameters. No additional inputs required if this value is set to Void.class.
    
    Default:
    
    java.lang.Void.class
- - mappedClassType
```
public abstract com.ibm.commerce.rest.javadoc.ClassType mappedClassType
```
    Returns:
    
    The type of mapped class, only necessary if mappedClass() is used.
    
    Default:
    
    com.ibm.commerce.rest.javadoc.ClassType.Pojo
- - mappedProfile
```
public abstract java.lang.String mappedProfile
```
    Returns:
    
    The profile used in the input mapping. Only necessary if mappedClass() is used.
    
    Default:
    
    ""