Interface ConfiguredAffordance
public interface ConfiguredAffordance
A configure affordance for inspection by media type implementations to create
AffordanceModel
instances.- Since:
- 1.3
- Author:
- Oliver Drotbohm
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionMetadata about the input payload.TheHttpMethod
of the affordance.Returns the explicitly configured name of theAffordance
or calculates a default based on theHttpMethod
and type backing it.Metadata about the output payload.The parameters of the affordance.Returns the affordance's target.
-
Method Details
-
getNameOrDefault
String getNameOrDefault()Returns the explicitly configured name of theAffordance
or calculates a default based on theHttpMethod
and type backing it.- Returns:
- will never be null.
-
getTarget
Link getTarget()Returns the affordance's target.- Returns:
- will never be null.
-
getMethod
HttpMethod getMethod()TheHttpMethod
of the affordance.- Returns:
- will never be null.
-
getInputMetadata
AffordanceModel.InputPayloadMetadata getInputMetadata()Metadata about the input payload.- Returns:
- will never be null.
-
getQueryParameters
List<QueryParameter> getQueryParameters()The parameters of the affordance.- Returns:
- will never be null.
-
getOutputMetadata
AffordanceModel.PayloadMetadata getOutputMetadata()Metadata about the output payload.- Returns:
- will never be null.
-