Package org.hl7.fhir.dstu2.model

Class OperationDefinition

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
    public class OperationDefinition
extends DomainResource
    A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
    See Also:
    Serialized Form

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

      • hasUrl

        public boolean hasUrl()

      • setUrlElement

        public OperationDefinition setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

      • getUrl

        public String getUrl()
        Returns:
        An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.

      • setUrl

        public OperationDefinition setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.

      • getVersionElement

        public StringType getVersionElement()
        Returns:
        version (The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • setVersionElement

        public OperationDefinition setVersionElement​(StringType value)
        Parameters:
        value - version (The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • getVersion

        public String getVersion()
        Returns:
        The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.

      • setVersion

        public OperationDefinition setVersion​(String value)
        Parameters:
        value - The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.

      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A free text natural language name identifying the operation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • hasName

        public boolean hasName()

      • setNameElement

        public OperationDefinition setNameElement​(StringType value)
        Parameters:
        value - name (A free text natural language name identifying the operation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • getName

        public String getName()
        Returns:
        A free text natural language name identifying the operation.

      • hasKind

        public boolean hasKind()

      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

      • setExperimentalElement

        public OperationDefinition setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

      • getExperimental

        public boolean getExperimental()
        Returns:
        This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

      • setExperimental

        public OperationDefinition setExperimental​(boolean value)
        Parameters:
        value - This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        publisher (The name of the individual or organization that published the operation definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • setPublisherElement

        public OperationDefinition setPublisherElement​(StringType value)
        Parameters:
        value - publisher (The name of the individual or organization that published the operation definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • getPublisher

        public String getPublisher()
        Returns:
        The name of the individual or organization that published the operation definition.

      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • hasDate

        public boolean hasDate()

      • setDateElement

        public OperationDefinition setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • getDate

        public Date getDate()
        Returns:
        The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.

      • setDate

        public OperationDefinition setDate​(Date value)
        Parameters:
        value - The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (A free text natural language description of the profile and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • setDescriptionElement

        public OperationDefinition setDescriptionElement​(StringType value)
        Parameters:
        value - description (A free text natural language description of the profile and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • getDescription

        public String getDescription()
        Returns:
        A free text natural language description of the profile and its use.

      • getRequirementsElement

        public StringType getRequirementsElement()
        Returns:
        requirements (Explains why this operation definition is needed and why it's been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

      • setRequirementsElement

        public OperationDefinition setRequirementsElement​(StringType value)
        Parameters:
        value - requirements (Explains why this operation definition is needed and why it's been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

      • getRequirements

        public String getRequirements()
        Returns:
        Explains why this operation definition is needed and why it's been constrained as it has.

      • getIdempotentElement

        public BooleanType getIdempotentElement()
        Returns:
        idempotent (Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.). This is the underlying object with id, value and extensions. The accessor "getIdempotent" gives direct access to the value

      • setIdempotentElement

        public OperationDefinition setIdempotentElement​(BooleanType value)
        Parameters:
        value - idempotent (Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.). This is the underlying object with id, value and extensions. The accessor "getIdempotent" gives direct access to the value

      • getIdempotent

        public boolean getIdempotent()
        Returns:
        Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.

      • setIdempotent

        public OperationDefinition setIdempotent​(boolean value)
        Parameters:
        value - Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.

      • getCodeElement

        public CodeType getCodeElement()
        Returns:
        code (The name used to invoke the operation.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

      • hasCode

        public boolean hasCode()

      • setCodeElement

        public OperationDefinition setCodeElement​(CodeType value)
        Parameters:
        value - code (The name used to invoke the operation.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

      • getCode

        public String getCode()
        Returns:
        The name used to invoke the operation.

      • getNotesElement

        public StringType getNotesElement()
        Returns:
        notes (Additional information about how to use this operation or named query.). This is the underlying object with id, value and extensions. The accessor "getNotes" gives direct access to the value

      • setNotesElement

        public OperationDefinition setNotesElement​(StringType value)
        Parameters:
        value - notes (Additional information about how to use this operation or named query.). This is the underlying object with id, value and extensions. The accessor "getNotes" gives direct access to the value

      • getNotes

        public String getNotes()
        Returns:
        Additional information about how to use this operation or named query.

      • getBase

        public Reference getBase()
        Returns:
        base (Indicates that this operation definition is a constraining profile on the base.)

      • hasBase

        public boolean hasBase()

      • getBaseTarget

        public OperationDefinition getBaseTarget()
        Returns:
        base The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates that this operation definition is a constraining profile on the base.)

      • setBaseTarget

        public OperationDefinition setBaseTarget​(OperationDefinition value)
        Parameters:
        value - base The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates that this operation definition is a constraining profile on the base.)

      • getSystemElement

        public BooleanType getSystemElement()
        Returns:
        system (Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value

      • setSystemElement

        public OperationDefinition setSystemElement​(BooleanType value)
        Parameters:
        value - system (Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value

      • getSystem

        public boolean getSystem()
        Returns:
        Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

      • setSystem

        public OperationDefinition setSystem​(boolean value)
        Parameters:
        value - Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

      • getType

        public List<CodeType> getType()
        Returns:
        type (Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).)

      • hasType

        public boolean hasType()

      • addTypeElement

        public CodeType addTypeElement()
        Returns:
        type (Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).)

      • addType

        public OperationDefinition addType​(String value)
        Parameters:
        value - type (Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).)

      • hasType

        public boolean hasType​(String value)
        Parameters:
        value - type (Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).)

      • getInstanceElement

        public BooleanType getInstanceElement()
        Returns:
        instance (Indicates whether this operation can be invoked on a particular instance of one of the given types.). This is the underlying object with id, value and extensions. The accessor "getInstance" gives direct access to the value

      • setInstanceElement

        public OperationDefinition setInstanceElement​(BooleanType value)
        Parameters:
        value - instance (Indicates whether this operation can be invoked on a particular instance of one of the given types.). This is the underlying object with id, value and extensions. The accessor "getInstance" gives direct access to the value

      • getInstance

        public boolean getInstance()
        Returns:
        Indicates whether this operation can be invoked on a particular instance of one of the given types.

      • setInstance

        public OperationDefinition setInstance​(boolean value)
        Parameters:
        value - Indicates whether this operation can be invoked on a particular instance of one of the given types.

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource