Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Document.RemoveEntryOfMultivaluedProperty

Remove Entry Of Multivalued Property

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 Document.RemoveEntryOfMultivaluedProperty
    AliasesRemoveEntryOfMultivaluedProperty
    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 org.nuxeo.ecm.automation.core.operations.document.RemoveEntryOfMultiValuedProperty
    Contributing component org.nuxeo.ecm.core.automation.coreContrib

    JSON definition

    {
      "id" : "Document.RemoveEntryOfMultivaluedProperty",
      "aliases" : [ "RemoveEntryOfMultivaluedProperty" ],
      "label" : "Remove Entry Of Multivalued Property",
      "category" : "Document",
      "requires" : null,
      "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><p>Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.</p>",
      "url" : "Document.RemoveEntryOfMultivaluedProperty",
      "signature" : [ "document", "document", "documents", "documents" ],
      "params" : [ {
        "name" : "value",
        "description" : "",
        "type" : "serializable",
        "required" : true,
        "widget" : null,
        "order" : 0,
        "values" : [ ]
      }, {
        "name" : "xpath",
        "description" : "",
        "type" : "string",
        "required" : true,
        "widget" : null,
        "order" : 0,
        "values" : [ ]
      }, {
        "name" : "is Remove All",
        "description" : "",
        "type" : "boolean",
        "required" : false,
        "widget" : null,
        "order" : 0,
        "values" : [ "true" ]
      }, {
        "name" : "save",
        "description" : "",
        "type" : "boolean",
        "required" : false,
        "widget" : null,
        "order" : 0,
        "values" : [ "true" ]
      } ],
      "widgets" : [ {
        "name" : "xpath",
        "type" : "codearea",
        "labels" : {
          "any" : "XPath"
        },
        "translated" : true,
        "handlingLabels" : false,
        "fields" : [ {
          "fieldName" : "xpath",
          "propertyName" : "xpath"
        } ],
        "properties" : {
          "any" : {
            "height" : "100%",
            "language" : "xpath",
            "width" : "100%"
          }
        }
      } ]
    }