zms.zmscustom.ZMSCustom

class documentation

class ZMSCustom(zmscontainerobject.ZMSContainerObject): (source)

Constructor: ZMSCustom(id, sort_id, meta_id, uid)

Custom content node with record-set editing and import helpers.

Method	`__init__`	Initialize a custom content node instance.
Method	`getEntityRecordHandler`	Create a helper that resolves foreign-key values for record exports.
Method	`getRecordSetMainGridContext`	Build rendering context for `zpt/ZMSRecordSet/main_grid.zpt`.
Method	`getRecordSetMainGridDefaultAction`	Return default JS onclick callback for row/grid actions.
Method	`getRecordSetMainGridInsertAction`	Return default JS onclick for opening the record-set insert form.
Method	`getRecordSetMainGridUpdateAction`	Return default JS onclick for opening the record-set update form.
Method	`manage_changeRecordGrid`	Update the record-set grid view with edited row values.
Method	`manage_changeRecordSet`	Insert, update, move, duplicate, or delete record-set entries.
Method	`manage_import`	Import content or record-set data into the custom object.
Method	`manage_options`	Undocumented
Method	`recordSet_Export`	Export record-set to XML or CSV via /recordSet_Export?lang=&qorder=&qorderdir=&mode=csv
Method	`recordSet_Filter`	Filter record-set.
Method	`recordSet_Init`	Initialize record-set.
Method	`recordSet_Sort`	Sort record-set.
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__authorPermissions__`	Undocumented
Class Variable	`__viewPermissions__`	Undocumented
Class Variable	`manage_coauthor`	Undocumented
Class Variable	`manage_menu`	Undocumented
Class Variable	`manage_properties`	Undocumented
Class Variable	`meta_type`	Undocumented
Class Variable	`metaobj_recordset_grid`	Undocumented
Class Variable	`metaobj_recordset_input_fields`	Undocumented
Class Variable	`metaobj_recordset_main`	Undocumented
Class Variable	`metaobj_recordset_main_grid`	Undocumented
Class Variable	`security`	Undocumented
Instance Variable	`meta_id`	Undocumented
Instance Variable	`_uid`	Undocumented

def __init__(self, id='', sort_id=0, meta_id=None, uid=''): (source) ¶

Initialize a custom content node instance.

Parameters
id:`str`	Object id.
sort_id:`int`	Sort position.
meta_id:`str`	Meta-object id describing the custom type.
uid:`str`	Optional persistent uid.

def getEntityRecordHandler(self, id): (source) ¶

Create a helper that resolves foreign-key values for record exports.

Parameters
id:`str`	Meta-object id of the exported record set.
Returns
`object`	Record transformation helper.

def getRecordSetMainGridContext(self, options, request): (source) ¶

Build rendering context for zpt/ZMSRecordSet/main_grid.zpt.

def getRecordSetMainGridDefaultAction(self, action, qindex=None): (source) ¶

Return default JS onclick callback for row/grid actions.

def getRecordSetMainGridInsertAction(self, url, lang, params=None, sort_id=None): (source) ¶

Return default JS onclick for opening the record-set insert form.

def getRecordSetMainGridUpdateAction(self, url, lang, qindex, params=None): (source) ¶

Return default JS onclick for opening the record-set update form.

def manage_changeRecordGrid(self, lang, btn, REQUEST, RESPONSE): (source) ¶

Update the record-set grid view with edited row values.

Parameters
lang:`str`	Active language.
btn:`str`	Submitted button id.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
RESPONSE:`ZPublisher.HTTPResponse`	Current response.

def manage_changeRecordSet(self, lang, btn, action, REQUEST, RESPONSE): (source) ¶

Insert, update, move, duplicate, or delete record-set entries.

Parameters
lang:`str`	Active language.
btn:`str`	Submitted button id.
action:`str`	Requested record-set action.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
RESPONSE:`ZPublisher.HTTPResponse`	Current response.

def manage_import(self, file, lang, REQUEST, RESPONSE=None): (source) ¶

Import content or record-set data into the custom object.

Parameters
file:`ZPublisher.HTTPRequest.FileUpload`	Uploaded import file.
lang:`str`	Active language.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
RESPONSE:`ZPublisher.HTTPResponse`	Optional response used for redirect handling.
Returns
`object`	Imported object when no response redirect is used.