Package org.hl7.fhir.r4.model.codesystems

Enum RestfulInteraction

java.lang.Object

java.lang.Enum<RestfulInteraction>

org.hl7.fhir.r4.model.codesystems.RestfulInteraction

All Implemented Interfaces:

Serializable, Comparable<RestfulInteraction>

public enum RestfulInteraction
extends Enum<RestfulInteraction>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATCH	perform a set of a separate interactions in a single http operation
CAPABILITIES	Get a Capability Statement for the system.
CREATE	Create a new resource with a server assigned id.
DELETE	Delete a resource.
HISTORY	Retrieve the change history for a particular resource, type of resource, or the entire system.
HISTORYINSTANCE	Retrieve the change history for a particular resource.
HISTORYSYSTEM	Retrieve the change history for all resources on a system.
HISTORYTYPE	Retrieve the change history for all resources of a particular type.
NULL	added to help the parsers
OPERATION	Perform an operation as defined by an OperationDefinition.
PATCH	Update an existing resource by posting a set of changes to it.
READ	Read the current state of the resource.
SEARCH	Search a resource type or all resources based on some filter criteria.
SEARCHSYSTEM	Search all resources based on some filter criteria.
SEARCHTYPE	Search all resources of the specified type based on some filter criteria.
TRANSACTION	Update, create or delete a set of resources as a single transaction.
UPDATE	Update an existing resource by its id (or create it if it is new).
VREAD	Read the state of a specific version of the resource.

Method Summary

Modifier and Type	Method	Description
static RestfulInteraction	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static RestfulInteraction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RestfulInteraction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READ

public static final RestfulInteraction READ

Read the current state of the resource.

VREAD

public static final RestfulInteraction VREAD

Read the state of a specific version of the resource.

UPDATE

public static final RestfulInteraction UPDATE

Update an existing resource by its id (or create it if it is new).

PATCH

public static final RestfulInteraction PATCH

Update an existing resource by posting a set of changes to it.

DELETE

public static final RestfulInteraction DELETE

Delete a resource.

HISTORY

public static final RestfulInteraction HISTORY

Retrieve the change history for a particular resource, type of resource, or the entire system.

HISTORYINSTANCE

public static final RestfulInteraction HISTORYINSTANCE

Retrieve the change history for a particular resource.

HISTORYTYPE

public static final RestfulInteraction HISTORYTYPE

Retrieve the change history for all resources of a particular type.

HISTORYSYSTEM

public static final RestfulInteraction HISTORYSYSTEM

Retrieve the change history for all resources on a system.

CREATE

public static final RestfulInteraction CREATE

Create a new resource with a server assigned id.

SEARCH

public static final RestfulInteraction SEARCH

Search a resource type or all resources based on some filter criteria.

SEARCHTYPE

public static final RestfulInteraction SEARCHTYPE

Search all resources of the specified type based on some filter criteria.

SEARCHSYSTEM

public static final RestfulInteraction SEARCHSYSTEM

Search all resources based on some filter criteria.

CAPABILITIES

public static final RestfulInteraction CAPABILITIES

Get a Capability Statement for the system.

TRANSACTION

public static final RestfulInteraction TRANSACTION

Update, create or delete a set of resources as a single transaction.

BATCH

public static final RestfulInteraction BATCH

perform a set of a separate interactions in a single http operation

OPERATION

public static final RestfulInteraction OPERATION

Perform an operation as defined by an OperationDefinition.

NULL

public static final RestfulInteraction NULL

added to help the parsers

Method Detail

values

public static RestfulInteraction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RestfulInteraction c : RestfulInteraction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RestfulInteraction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromCode

public static RestfulInteraction fromCode(String codeString)
                                   throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()