Platform Explorer / Nuxeo Platform 5.8

Operation RemoveEntryOfMultivaluedProperty (Remove Entry Of Multivalued Property)

In component BuiltIn

Description

Remove the first entry of the giving value in the multivalued xpath, does nothing if does not exist: if 'is Remove All' is check, all entry instance in the list.
  • if not will remove just the first one found
    Operation id RemoveEntryOfMultivaluedProperty
    Category Document
    Label Remove Entry Of Multivalued Property
    Requires
    Since

    Parameters

    Name Description Type Required Default value
    value serializable yes  
    xpath string yes  
    is Remove All boolean no true 
    save boolean no true 

    Signature

    Inputs document, documents
    Outputs document, documents

    Implementation Information

    Implementation Class Javadoc: org.nuxeo.ecm.automation.core.operations.document.RemoveEntryOfMultiValuedProperty
    Contributing Component BuiltIn

    JSON Definition

    {
      "id" : "RemoveEntryOfMultivaluedProperty",
      "label" : "Remove Entry Of Multivalued Property",
      "category" : "Document",
      "requires" : "",
      "description" : "Remove the first entry of the giving value in the multivalued xpath, does nothing if does not exist: <ul<li>if 'is Remove All' is check, all entry instance in the list.</li><li>if not will remove just the first one found</li><ul>",
      "url" : "RemoveEntryOfMultivaluedProperty",
      "signature" : [ "document", "document", "documents", "documents" ],
      "params" : [ {
        "name" : "value",
        "description" : null,
        "type" : "serializable",
        "required" : true,
        "widget" : "",
        "order" : 0,
        "values" : [ ]
      }, {
        "name" : "xpath",
        "description" : null,
        "type" : "string",
        "required" : true,
        "widget" : "",
        "order" : 0,
        "values" : [ ]
      }, {
        "name" : "is Remove All",
        "description" : null,
        "type" : "boolean",
        "required" : false,
        "widget" : "",
        "order" : 0,
        "values" : [ "true" ]
      }, {
        "name" : "save",
        "description" : null,
        "type" : "boolean",
        "required" : false,
        "widget" : "",
        "order" : 0,
        "values" : [ "true" ]
      } ]
    }