= SchemaValueMarshaller
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Provides the runtime context for converting values between their XML _Schema_ and their _Java_ type representation, based on xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] if specified.

== API

[source,java]
.SchemaValueMarshaller.java
----
interface SchemaValueMarshaller {
  Identifier actionIdentifier(ActionInvocationDto actionInvocationDto)     // <.>
  Identifier actionIdentifier(ActionDto actionDto)     // <.>
  Identifier propertyIdentifier(PropertyDto propertyDto)     // <.>
  ManagedObject recoverReferenceFrom(OidDto oidDto)
  ManagedObject recoverPropertyFrom(PropertyDto propertyDto)     // <.>
  ManagedObject recoverParameterFrom(Identifier paramIdentifier, ParamDto paramDto)     // <.>
  ActionInvocationDto recordActionResultScalar(ActionInvocationDto invocationDto, ObjectAction objectAction, ManagedObject value)     // <.>
  ActionInvocationDto recordActionResultNonScalar(ActionInvocationDto invocationDto, ObjectAction objectAction, Can<ManagedObject> values)     // <.>
  PropertyDto recordPropertyValue(PropertyDto propertyDto, OneToOneAssociation property, ManagedObject value)     // <.>
  ParamDto recordParamScalar(ParamDto paramDto, ObjectActionParameter param, ManagedObject value)     // <.>
  ParamDto recordParamNonScalar(ParamDto paramDto, ObjectActionParameter param, Can<ManagedObject> values)     // <.>
}
----

<.> xref:#actionIdentifier_ActionInvocationDto[actionIdentifier(ActionInvocationDto)]
+
--
Recovers an _Action's_ xref:refguide:applib:index/Identifier.adoc[Identifier] from given DTO.
--
<.> xref:#actionIdentifier_ActionDto[actionIdentifier(ActionDto)]
+
--
Recovers an _Action's_ xref:refguide:applib:index/Identifier.adoc[Identifier] from given DTO.
--
<.> xref:#propertyIdentifier_PropertyDto[propertyIdentifier(PropertyDto)]
+
--
Recovers a _Property's_ xref:refguide:applib:index/Identifier.adoc[Identifier] from given DTO.
--
<.> xref:#recoverPropertyFrom_PropertyDto[recoverPropertyFrom(PropertyDto)]
+
--
Recovers a property value, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Property_ . Cardinality _0..1_
--
<.> xref:#recoverParameterFrom_Identifier_ParamDto[recoverParameterFrom(Identifier, ParamDto)]
+
--
Recovers a parameter value, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action Parameter_ . Cardinality _0..n_
--
<.> xref:#recordActionResultScalar_ActionInvocationDto_ObjectAction_ManagedObject[recordActionResultScalar(ActionInvocationDto, ObjectAction, ManagedObject)]
+
--
Records given result value into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action_ .
--
<.> xref:#recordActionResultNonScalar_ActionInvocationDto_ObjectAction_Can[recordActionResultNonScalar(ActionInvocationDto, ObjectAction, Can)]
+
--
Records given result values into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action_ .
--
<.> xref:#recordPropertyValue_PropertyDto_OneToOneAssociation_ManagedObject[recordPropertyValue(PropertyDto, OneToOneAssociation, ManagedObject)]
+
--
Records given property value into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Property_ .
--
<.> xref:#recordParamScalar_ParamDto_ObjectActionParameter_ManagedObject[recordParamScalar(ParamDto, ObjectActionParameter, ManagedObject)]
+
--
Records given parameter value into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action Parameter_ .
--
<.> xref:#recordParamNonScalar_ParamDto_ObjectActionParameter_Can[recordParamNonScalar(ParamDto, ObjectActionParameter, Can)]
+
--
Records given parameter values into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action Parameter_ .
--

== Members

[#actionIdentifier_ActionInvocationDto]
=== actionIdentifier(ActionInvocationDto)

Recovers an _Action's_ xref:refguide:applib:index/Identifier.adoc[Identifier] from given DTO.

[#actionIdentifier_ActionDto]
=== actionIdentifier(ActionDto)

Recovers an _Action's_ xref:refguide:applib:index/Identifier.adoc[Identifier] from given DTO.

[#propertyIdentifier_PropertyDto]
=== propertyIdentifier(PropertyDto)

Recovers a _Property's_ xref:refguide:applib:index/Identifier.adoc[Identifier] from given DTO.

[#recoverPropertyFrom_PropertyDto]
=== recoverPropertyFrom(PropertyDto)

Recovers a property value, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Property_ . Cardinality _0..1_

[#recoverParameterFrom_Identifier_ParamDto]
=== recoverParameterFrom(Identifier, ParamDto)

Recovers a parameter value, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action Parameter_ . Cardinality _0..n_

Packed up if non-scalar.

[#recordActionResultScalar_ActionInvocationDto_ObjectAction_ManagedObject]
=== recordActionResultScalar(ActionInvocationDto, ObjectAction, ManagedObject)

Records given result value into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action_ .

[#recordActionResultNonScalar_ActionInvocationDto_ObjectAction_Can]
=== recordActionResultNonScalar(ActionInvocationDto, ObjectAction, Can)

Records given result values into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action_ .

[#recordPropertyValue_PropertyDto_OneToOneAssociation_ManagedObject]
=== recordPropertyValue(PropertyDto, OneToOneAssociation, ManagedObject)

Records given property value into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Property_ .

[#recordParamScalar_ParamDto_ObjectActionParameter_ManagedObject]
=== recordParamScalar(ParamDto, ObjectActionParameter, ManagedObject)

Records given parameter value into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action Parameter_ .

[#recordParamNonScalar_ParamDto_ObjectActionParameter_Can]
=== recordParamNonScalar(ParamDto, ObjectActionParameter, Can)

Records given parameter values into given DTO object, using xref:refguide:applib:index/value/semantics/ValueSemanticsProvider.adoc[ValueSemanticsProvider] for corresponding _Action Parameter_ .
