Skip to content

Class: FunctionInvocation

The Function Invocation object provides details regarding the invocation of a

function.

URI: ocsf:FunctionInvocation

 classDiagram
    class FunctionInvocation
    click FunctionInvocation href "../FunctionInvocation/"
      Object <|-- FunctionInvocation
        click Object href "../Object/"

      FunctionInvocation : error

      FunctionInvocation : parameters





        FunctionInvocation --> "*" Parameter : parameters
        click Parameter href "../Parameter/"



      FunctionInvocation : return_value

Inheritance

Slots

Name Cardinality and Range Description Inheritance
error 0..1
String		 The error indication returned from the function direct
parameters *
Parameter		 The parameters passed into a function invocation direct
return_value 0..1
String		 The value returned from a function direct

Usages

used by used in type used
Module function_invocation range FunctionInvocation

Rules

Rule Applied Preconditions Postconditions Elseconditions
any_of [{'slot_conditions': {'parameters': {'required': True}}}, {'slot_conditions': {'return_value': {'required': True}}}, {'slot_conditions': {'error': {'required': True}}}]

In Subsets

Aliases

  • Function Invocation

Identifier and Mapping Information

Annotations

property value
ocsf_constraints {"at_least_one": ["parameters", "return_value", "error"]}

Schema Source

Mappings

Mapping Type Mapped Value
self ocsf:FunctionInvocation
native ocsf:FunctionInvocation

LinkML Source

Direct

name: FunctionInvocation
annotations:
  ocsf_constraints:
    tag: ocsf_constraints
    value: '{"at_least_one": ["parameters", "return_value", "error"]}'
description: 'The Function Invocation object provides details regarding the invocation
  of a

  function.'
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Function Invocation
is_a: Object
slots:
- error
- parameters
- return_value
slot_usage:
  error:
    name: error
    description: 'The error indication returned from the function. This may differ
      from the

      return value (e.g. when <code>errno</code> is used).'
rules:
- postconditions:
    any_of:
    - slot_conditions:
        parameters:
          name: parameters
          required: true
    - slot_conditions:
        return_value:
          name: return_value
          required: true
    - slot_conditions:
        error:
          name: error
          required: true
  description: 'OCSF at_least_one: at least one of [''parameters'', ''return_value'',
    ''error''] must

    be set.'

Induced

name: FunctionInvocation
annotations:
  ocsf_constraints:
    tag: ocsf_constraints
    value: '{"at_least_one": ["parameters", "return_value", "error"]}'
description: 'The Function Invocation object provides details regarding the invocation
  of a

  function.'
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Function Invocation
is_a: Object
slot_usage:
  error:
    name: error
    description: 'The error indication returned from the function. This may differ
      from the

      return value (e.g. when <code>errno</code> is used).'
attributes:
  error:
    name: error
    description: 'The error indication returned from the function. This may differ
      from the

      return value (e.g. when <code>errno</code> is used).'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Error Code
    rank: 1000
    alias: error
    owner: FunctionInvocation
    domain_of:
    - Response
    - FunctionInvocation
    range: string
  parameters:
    name: parameters
    description: The parameters passed into a function invocation.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Parameters
    rank: 1000
    alias: parameters
    owner: FunctionInvocation
    domain_of:
    - FunctionInvocation
    range: Parameter
    multivalued: true
  return_value:
    name: return_value
    description: The value returned from a function.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Return Value
    rank: 1000
    alias: return_value
    owner: FunctionInvocation
    domain_of:
    - FunctionInvocation
    range: string
rules:
- postconditions:
    any_of:
    - slot_conditions:
        parameters:
          name: parameters
          required: true
    - slot_conditions:
        return_value:
          name: return_value
          required: true
    - slot_conditions:
        error:
          name: error
          required: true
  description: 'OCSF at_least_one: at least one of [''parameters'', ''return_value'',
    ''error''] must

    be set.'