Package com.ibm.fhir.model.type

Class ParameterDefinition

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.ParameterDefinition

All Implemented Interfaces:

Visitable

@Generated("com.ibm.fhir.tools.CodeGenerator")
public class ParameterDefinition
extends Element

The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParameterDefinition.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.Element

extension, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static ParameterDefinition.Builder	builder()
boolean	equals(Object obj)
String	getDocumentation()	A brief discussion of what the parameter is for and how it is used by the module.
String	getMax()	The maximum number of times this element is permitted to appear in the request or response.
Integer	getMin()	The minimum number of times this parameter SHALL appear in the request or response.
Code	getName()	The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
Canonical	getProfile()	If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
FHIRAllTypes	getType()	The type of the parameter.
ParameterUse	getUse()	Whether the parameter is input or output for the module.
boolean	hasChildren()
int	hashCode()
ParameterDefinition.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getName

public Code getName()

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

Returns:

An immutable object of type Code that may be null.

getUse

public ParameterUse getUse()

Whether the parameter is input or output for the module.

Returns:

An immutable object of type ParameterUse that is non-null.

getMin

public Integer getMin()

The minimum number of times this parameter SHALL appear in the request or response.

Returns:

An immutable object of type Integer that may be null.

getMax

public String getMax()

The maximum number of times this element is permitted to appear in the request or response.

Returns:

An immutable object of type String that may be null.

getDocumentation

public String getDocumentation()

A brief discussion of what the parameter is for and how it is used by the module.

Returns:

An immutable object of type String that may be null.

getType

public FHIRAllTypes getType()

The type of the parameter.

Returns:

An immutable object of type FHIRAllTypes that is non-null.

getProfile

public Canonical getProfile()

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

Returns:

An immutable object of type Canonical that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class Element

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public ParameterDefinition.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class Element

builder

public static ParameterDefinition.Builder builder()