~openerp-vietnam/openobject-doc/technical-tutorial

<dt>args: a list of tuples containing the search criteria. This list must be of the form: [(‘name_of_the_field’, ‘operator’, value), ...]. The available operators are:</dt>

102

103

104

105

<li>LIKE, ILIKE (sql)</li>

106

<li>child_of</li>

107

</ul>

108

</dd>

109

</dl>

110

</li>

111

<li>offset (optional): do not return the “offset” first results.

112

</li>

113

<li>limit (optional): maximum number of results to return.

114

</li>

115

</ul>

116

</blockquote>

117

Returns: the list of ids of matching resources.

118

Example:

119

<div class="highlight-python"><div class="highlight"><pre>ids = pooler.get_pool(cr.dbname).get('res.partner').search(cr, uid, [('category_id', '=', 'Customer')])

120

</pre></div>

121

</div>

122

This example will return a list with all the partners that have the category ‘Customer’.

123

124

<dt>

125

126

127

128

129

130

131

132

<tr class="field"><th class="field-name">Description:</th><td class="field-body"></td>

133

</tr>

134

</tbody>

135

</table>

136

List of fields resources values.

137

138

Signature: def read(self, cr, uid, ids, fields=None, context={})

139

Parameters:

140

141

142

143

<li>ids: list of the identifiers of the resources to read (list of integers).</li>

144

<li>fields (optional): the list of the interested fields. If a value is not provided for this parameter, the function will check all the fields.</li>

145

<li>context (optional): the actual context dictionary.</li>

146

</ul>

147

</blockquote>

148

Returns: A list of dictionaries (a dictionary per resource asked) of the form [{‘name_of_the_field’: value, ...}, ...]

149

</blockquote>

150

</blockquote>

151

Example:

152

<div class="highlight-python"><pre>values = pooler.get_pool(cr.dbname).get('res.partner').

153

read(cr, uid, ids, ['name','category_id'], context=context)</pre>

154

</div>

155

156

<dt>

157

<tt class="descname">browse</tt></dt>

158

159

160

161

162

163

164

<tr class="field"><th class="field-name">Description:</th><td class="field-body"></td>

165

</tr>

166

</tbody>

167

</table>

168

Return one or several resources with the objects form. These object fields can be reached directly with the pointed notation (“object.name_of_the_field”). The “relations” fields are also automatically evaluated to allow you to recover the values in the “neighbors” objects.

169

170

Signature: def browse(self, cr, uid, select, offset=0, limit=2000)

171

Parameters

172

173

<ul>

174

175

<dt>select: this parameter accept data of several types:</dt>

176

177

<li>an integer : identifier of a resource</li>

178

<li>a list of integers (list of identifiers)</li>

179

</ul>

180

</dd>

181

</dl>

182

</li>

183

<li>offset (optional): the number of results to pass.

184

</li>

185

<li>limit (optional): the maximum number of results to return.

186

</li>

187

</ul>

188

</blockquote>

189

Returns:

190

191

192

<li>if an integer (identifier) has been passed as select parameter, return an object having the properties described here above.</li>

193

<li>if a list of integer (identifiers) has been passed, return the object list.</li>

194

</ul>

195

</blockquote>

196

</blockquote>

197

198

199

200

201

<tr class="field"><th class="field-name">Example:</th><td class="field-body"></td>

202

</tr>

203

</tbody>

204

</table>

205

Let’s consider the case of a partner (object ‘res.partner’) and of a partner contact (object ‘res.partner.address’). Let’s suppose that we know the identifier of a partner contact (name contact_id) and we want to recover his name and the account number of the company he works for.

206

Knowing that the object res.partner contains the field:

207

<div class="highlight-python"><pre>'bank':fields.char('Bank account',size=64),</pre>

208

</div>

209

and the object res.partner.address contains the fields:

210

<div class="highlight-python"><pre>'partner_id': fields.many2one('res.partner', 'Partner', required=True),

211

'name': fields.char('Contact Name', size=64),</pre>

212

</div>

213

the most simple way to proceed is to use the browse method:

214

<div class="highlight-python"><div class="highlight"><pre>addr_obj = self.pool.get('res.partner.address').browse(cr, uid, contact_id)

215

</pre></div>

216

</div>

217

so, to recover the two fields that interest us, you have to write:

218

<div class="highlight-python"><div class="highlight"><pre>name = addr_obj.name

219

account_num = addr_obj.partner_id.bank

220

</pre></div>

221

</div>

222

223

Note

224

This method is only useful locally (on the server itself) and not with the other interfaces !!

225

</div>

226

227

<dt>

228

<tt class="descname">write</tt></dt>

229

230

231

232

233

234

235

<tr class="field"><th class="field-name">Description:</th><td class="field-body"></td>

236

</tr>

237

</tbody>

238

</table>

239

Writes values in one or several fields of one or several resources

240

241

Signature: def write(self, cr, uid, ids, vals, context={})

242

Parameters:

243

244

245

<li>ids: the resources identifiers list to modify.</li>

246

<li>vals: a dictionary with values to write. This dictionary must be with the form: {‘name_of_the_field’: value, ...}.</li>

247

<li>context (optional): the actual context dictionary.</li>

248

</ul>

249

</blockquote>

250

Returns: True

251

</blockquote>

252

Example:

253

<div class="highlight-python"><div class="highlight"><pre>self.pool.get('sale.order').write(cr, uid, ids, {'state':'cancel'})

254

</pre></div>

255

</div>

256

257

<dt>

258

<tt class="descname">unlink</tt></dt>

259

260

261

262

263

264

265

<tr class="field"><th class="field-name">Description:</th><td class="field-body"></td>

266

</tr>

267

</tbody>

268

</table>

269

Delete one or several resources

270

271

Signature: def unlink(self, cr, uid, ids)

272

Parameters:

273

274

275

<li>ids: the identifiers resources list to delete.</li>

276

</ul>

277

</blockquote>

278

Returns: True

279

</blockquote>

280

Example:

281

<div class="highlight-python"><div class="highlight"><pre>self.pool.get('sale.order').unlink(cr,uid, ids)

282

</pre></div>

283

</div>

284

285

<h2>Methods to manipulate the default values<a class="headerlink" href="#methods-to-manipulate-the-default-values" title="Permalink to this headline">¶</a></h2>

286

287

<dt>

288

<tt class="descname">default_get</tt></dt>

289

290

291

292

293

294

295

<tr class="field"><th class="field-name">Description:</th><td class="field-body"></td>

296

</tr>

297

</tbody>

298

</table>

299

Get back the value by default for one or several fields.

300

301

Signature: def default_get(self, cr, uid, fields, form=None, reference=None)

302

Parameters:

303

304

305

<li>fields: the fields list which we want to recover the value by default.</li>

306

<li>form (optional): TODO</li>

307

<li>reference (optional): TODO</li>

308

</ul>

309

</blockquote>

310

Returns: dictionary of the default values of the form {‘field_name’: value, ... }

311

</blockquote>

312

Example:

313

<div class="highlight-python"><div class="highlight"><pre>self.pool.get('hr.analytic.timesheet').default_get(cr, uid, ['product_id','product_uom_id'])

314

</pre></div>

315

</div>

316

317

<dt>

318

<tt class="descname">default_set</tt></dt>

319

320

321

322

323

324

325

<tr class="field"><th class="field-name">Description:</th><td class="field-body"></td>

326

</tr>

327

</tbody>

328

</table>

329

Change the default value for one or several fields.

330

331

Signature: def default_set(self, cr, uid, field, value, for_user=False)

332

Parameters:

333

334

335

<li>field: the name of the field that we want to change the value by default.</li>

336

<li>value: the value by default.</li>

337

<li>for_user (optional): boolean that determines if the new default value must be available only for the current user or for all users.</li>

338

</ul>

339

</blockquote>

340

Returns: True

341

</blockquote>

342

Example:

343

<div class="highlight-python"><div class="highlight"><pre>TODO

344

</pre></div>

345

</div>

346

</div>

347

348

<h2>Methods to manipulate the permissions<a class="headerlink" href="#methods-to-manipulate-the-permissions" title="Permalink to this headline">¶</a></h2>

349

350

<dt>

351

352

353

354

355

356

357

358

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def perm_read(self, cr, uid, ids)

359

Parameters:

360

361

362

<li>ids: an integer list</li>

363

</ul>

364

</blockquote>

365

Returns: a list of dictionaries with the following keys

366

367

368

<li>level : access level</li>

369

370

<li>gid : group id</li>

371

<li>create_uid: user who created the resource</li>

372

<li>create_date: date when the resource was created</li>

373

<li>write_uid: last user who changed the resource</li>

374

<li>write_date: date of the last change to the resource</li>

375

</ul>

376

</blockquote>

377

</td>

378

</tr>

379

</tbody>

380

</table>

381

382

<dt>

383

<tt class="descname">perm_write</tt></dt>

384

385

386

387

388

389

390

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def perm_write(self, cr, uid, ids, fields)

391

Parameters:

392

Returns:

393

</td>

394

</tr>

395

</tbody>

396

</table>

397

Example:

398

<div class="highlight-python"><div class="highlight"><pre>self.pool.get('res.partner').perm_read(cr, uid, ids, context)

399

</pre></div>

400

</div>

401

</div>

402

403

<h2>Methods to generate the fields and the views<a class="headerlink" href="#methods-to-generate-the-fields-and-the-views" title="Permalink to this headline">¶</a></h2>

404

405

<dt>

406

<tt class="descname">fields_get</tt></dt>

407

408

409

410

411

412

413

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def fields_get(self, cr, uid, fields = None, context={})

414

Parameters:

415

416

417

<li>fields: a list of fields that interest us, if None, all the fields</li>

418

<li>context: context[‘lang’]</li>

419

</ul>

420

</blockquote>

421

Result:

422

</td>

423

</tr>

424

</tbody>

425

</table>

426

Example:

427

In payment.line in account_payment module

428

<div class="highlight-python"><div class="highlight"><pre>def fields_get(self, cr, uid, fields=None, context=None):

429

res = super(payment_line, self).fields_get(cr, uid, fields, context)

430

if 'communication2' in res:

431

res['communication2'].setdefault('states', {})

432

res['communication2']['states']['structured'] = [('readonly', True)]

433

res['communication2']['states']['normal'] = [('readonly', False)]

434

return res

435

</pre></div>

436

</div>

437

438

<dt>

439

<tt class="descname">fields_view_get</tt></dt>

440

441

442

443

444

445

446

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def fields_view_get(self, cr, uid, view_id=None, view_type=’form’, context={}, toolbar=False)

447

Parameters:

448

Result:

449

</td>

450

</tr>

451

</tbody>

452

</table>

453

Example:

454

In membership module [product.product]:

455

<div class="highlight-python"><pre>def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False):

456

if ('product' in context) and (context['product']=='membership_product'):

457

model_data_ids_form = self.pool.get('ir.model.data').search(cr,user,[('model','=','ir.ui.view'),('name','in',

458

['membership_products_form','membership_products_tree'])])

459

resource_id_form = self.pool.get('ir.model.data').

460

read(cr,user,model_data_ids_form,fields=['res_id','name'])

461

dict_model={}

462

for i in resource_id_form:

463

dict_model[i['name']]=i['res_id']

464

if view_type=='form':

465

view_id = dict_model['membership_products_form']

466

else:

467

view_id = dict_model['membership_products_tree']

468

return super(Product,self).fields_view_get(cr, user, view_id, view_type, context, toolbar)</pre>

469

</div>

470

471

<dt>

472

<tt class="descname">distinct_field_get</tt></dt>

473

474

475

476

477

478

479

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def distinct_field_get(self, cr, uid, field, value, args=[], offset=0, limit=2000)

480

Parameters:

481

Result:

482

</td>

483

</tr>

484

</tbody>

485

</table>

486

Example:

487

<div class="highlight-python"><div class="highlight"><pre>TODO

488

</pre></div>

489

</div>

490

</div>

491

492

<h2>Methods concerning the name of the resources<a class="headerlink" href="#methods-concerning-the-name-of-the-resources" title="Permalink to this headline">¶</a></h2>

493

494

<dt>

495

496

497

498

499

500

501

502

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def name_get(self, cr, uid, ids, context={})

503

Parameters:

504

Result: a list of tuples of the form [(id, name), ...]

505

</td>

506

</tr>

507

</tbody>

508

</table>

509

Example:

510

In res.partner.address:

511

<div class="highlight-python"><div class="highlight"><pre>def name_get(self, cr, user, ids, context={}):

512

if not len(ids):

513

return []

514

res = []

515

for r in self.read(cr, user, ids, ['name','zip','city']):

516

addr = str(r['name'] or '')

517

if r['name'] and (r['zip'] or r['city']):

518

addr += ', '

519

addr += str(r['zip'] or '') + ' ' + str(r['city'] or '')

520

res.append((r['id'], addr))

521

return res

522

</pre></div>

523

</div>

524

525

<dt>

526

<tt class="descname">name_search</tt></dt>

527

528

529

530

531

532

533

<tr class="field"><th class="field-name">Description:</th><td class="field-body">Signature: def name_search(self, cr, uid, name=, args=[], operator=’ilike’, context={})

534

‘Parameters:

535

Result:

536

</td>

537

</tr>

538

</tbody>

539

</table>

540

Example:

541

In res.country:

542

<div class="highlight-python"><div class="highlight"><pre>def name_search(self, cr, user, name='', args=None, operator='ilike',

543

context=None, limit=80):

544

if not args:

545

args=[]

546

if not context:

547

context={}

548

ids = False

549

if len(name) == 2:

550

ids = self.search(cr, user, [('code', '=', name)] + args,

551

limit=limit, context=context)

552

if not ids:

553

ids = self.search(cr, user, [('name', operator, name)] + args,

554

555

return self.name_get(cr, user, ids, context)

556

</pre></div>

557

</div>

558

</div>

559

</div>

560

561

562

</div>

563

</div>

564

</div>

565

566

567

<h3><a href="../index.html">Table Of Contents</a></h3>

568

<ul>

569

<li><a class="reference external" href="">ORM methods</a><ul>

570

<li><a class="reference external" href="#methods-to-manipulate-the-default-values">Methods to manipulate the default values</a></li>

571

<li><a class="reference external" href="#methods-to-manipulate-the-permissions">Methods to manipulate the permissions</a></li>

572

<li><a class="reference external" href="#methods-to-generate-the-fields-and-the-views">Methods to generate the fields and the views</a></li>

573

<li><a class="reference external" href="#methods-concerning-the-name-of-the-resources">Methods concerning the name of the resources</a></li>

574

</ul>

575

</li>

576

</ul>

577

578

<h4>Previous topic</h4>

579

<a href="field_type.html"

580

title="previous chapter">Type of Fields</a>

581

<h4>Next topic</h4>

582

<a href="../part_5/index.html"

583

title="next chapter">Workflows</a>

584

585

586

<li><a href="../_sources/part_4/methods.txt"

587

rel="nofollow">Show Source</a></li>

588

</ul>

589

590

<h3>Quick search</h3>

591

592

593

594

595

596

</form>

597

598

Enter search terms or a module, class or function name.

599

600

</div>

601

602

</div>

603

</div>

604

605

</div>

606

607

<h3>Navigation</h3>

608

<ul>

609

610

<a href="../genindex.html" title="General Index"

611

>index</a></li>

612

613

<a href="../part_5/index.html" title="Workflows"

614

>next</a> |</li>

615

616

<a href="field_type.html" title="Type of Fields"

617

>previous</a> |</li>

618

<li><a href="../index.html">openerp v1 documentation</a> »</li>

619

<li><a href="index.html" >Objects, Fields and Methods</a> »</li>

620

</ul>

621

</div>

622

623

624

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.

625

</div>

626

</body>

627

</html>

b'\\ No newline at end of file'

Older »