CMIS Field

This is the API documentation for new field defined by the addob cmis_field.

These classes are not intended for use by module developers.

cmis_field.fields.cmis_folder.CmisFolder[source]

A reference to a cmis:folder. (cmis:objectId)

Parameters:
  • backend_name – The attribute backend_name is mandatory
  • allow_create – Allow create from UI (by default True)
  • allow_delete – Allow delete from UI (by default False)
  • create_method – name of a method that create the field into the CMIS repository. The method must assign the field on all records of the invoked recordset. The method is called with the field definition instance and the bakend as paramaters (optional)
  • create_parent_get – name of a method that return the cmis:objectId of the folder to use as parent. The method is called with the field definition instance and the bakend as paramaters. (optional: by default the folder is created as child of backend.initial_directory_write + ‘/’ model._name)
  • create_name_get – name of a method that return the name of the folder to create into the CMIS repository. The method is called with the field definition instance and the bakend as paramaters. (optional: by default instance.name_get)
Return type:

dict

Returns:

a dictionay with an entry for each record of the invoked recordset with the following structure

{record.id: 'cmis:objectId'}

Return type:

dict

Returns:

a dictionay with an entry for each record of the invoked recordset with the following structure

{record.id: 'name'}

Parem create_properties_get:
 

name of a method that return a dictionary of CMIS properties ro use to create the folder. The method is called with the field definition instance and the bakend as paramaters (optional: default empty)

Return type:

dict

Returns:

a dictionay with an entry for each record of the invoked recordset with the following structure

{record.id: {'cmis:xxx': 'val1', ...}}