Welcome to Scribd, the world's digital library. Read, publish, and share books and documents. See more
Download
Standard view
Full view
of .
Look up keyword
Like this
2Activity
0 of .
Results for:
No results containing your search query
P. 1
BOFComponentGuidelinesDocumentation

BOFComponentGuidelinesDocumentation

Ratings:

4.0

(2)
|Views: 115 |Likes:
Published by api-3726220

More info:

Published by: api-3726220 on Oct 17, 2008
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

03/18/2014

pdf

text

original

Documentum Developer Program
BOF Component Development Guidelines
March 2004
Developer Program
Component Exchange
1/18
Preface

Documentum engineers have gained considerable experience over the years developing
reusable business objects for our client applications. In an effort to capture lessons
learned from this experience, several key engineers collaborated to produce a collection
of best practices and guidelines for business object development. These are now used
internally by all Documentum engineers when developing and unit testing business
objects.

We are pleased to make this development guide available to our developer community. Please remember that the goal is to facilitate component reuse, extendibility, and quality; they are not intended to be an exhaustive list of requirements.

Organization of this Guide

The guide starts with checklists that you can use for BOF components with links to a more detailed guidelines section later in the guide. There are also supporting sections containing definitions of BOF components and a list of other sources of information.

Developer Program
Component Exchange
2/18
Table of Contents

Preface.............................................................................................................................. 2
Organization of this Guide............................................................................................. 2
Table of Contents.............................................................................................................. 3
Checklists.......................................................................................................................... 4
BOF Component Checklist............................................................................................ 5
General Guidelines........................................................................................................... 8
Audience........................................................................................................................ 8
How to be used.............................................................................................................. 8
Definitions and Overview of BOF Components................................................................. 8
BOF Component Definitions and Overview................................................................... 8
Service-Based Object (SBO)..................................................................................... 8
Type-based Object (TBO).......................................................................................... 8
BOF Component Guidelines............................................................................................. 9
What Constitutes a Good BOF Component?................................................................ 9
Environmental Friendliness........................................................................................... 9
[BOF-LOG] Logging................................................................................................... 9

[BOF-TRANSX] Transactions...................................................................................9
[BOF-SESS] Session Manager...............................................................................10

BOF-VERS Versioning Support................................................................................... 10
IDfBusinessObject Methods..................................................................................... 10
Design......................................................................................................................... 11
[BOF-SBO] SBO design........................................................................................... 11
[BOF-TBO] TBO design........................................................................................... 15
[BOF-EXCEP] Exceptions........................................................................................ 15
[BOF-CONV] BOF Conventions/Standards............................................................. 16
[BOF-DOC] Documentation......................................................................................... 17
[BOF-DOC-01] Javadocs exist for interfaces........................................................... 17
[BOF-DOC-02] TBO Docbase type definition documented...................................... 17
[BOF-DOC-03] Transaction environment expectations documented....................... 17
[BOF-DOC-04] Transaction behavior documented.................................................. 17
[BOF-DOC-05] Component dependencies documented......................................... 17
[BOF-DOC-06] Supported "features" documented.................................................. 17
[BOF-DOC-07] Version (in)compatibilities documented.......................................... 17
[BOF-DOC-08] Customization hooks documented.................................................. 17
[BOF-DOC-09] Java Runtime Requirements........................................................... 17
[BOF-DOC-10] Known issues documented............................................................. 18
[BOF-DOC-11] License terms documented............................................................. 18
[BOF-DOC-12] (Optional) Support and contact info documented............................ 18
[BOF-DEPLOY] Deployment....................................................................................... 18
[BOF-DEPLOY-01] Jars, not classes....................................................................... 18
[BOF-DEPLOY-02] Implementation/interface jars separate.................................... 18
[BOF-DEPLOY-03] Native code prohibited.............................................................. 18
Client Use of BOs........................................................................................................ 18
Key Documents/References........................................................................................... 18
General........................................................................................................................ 18
BOF-specific................................................................................................................ 18

Developer Program
Component Exchange
3/18

You're Reading a Free Preview

Download
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->