CodeBeamer 5.4.0.1-RC API

Package com.intland.codebeamer.manager

The Service Layer package (also known as Business Layer or Business Tier) captures CodeBeamer's core business logic.

See:
          Description

Exception Summary
AccessRightsException This is thrown when a user wants to access a resource without having access permission to that.
 

Package com.intland.codebeamer.manager Description

The Service Layer package (also known as Business Layer or Business Tier) captures CodeBeamer's core business logic. This acts like a client-side business abstraction and hides the underlying implementation details, too.
The initiator of a Service Layer operation can be an action invoked from the Web Layer (Presentation Layer), a remote method call invoked from the CodeBeamer remote API or even a wiki plugin.

All the Service Layer objects (the "entity managers"):

The managers support the following base groups of methods:

  1. CRUD operation methods: methods to Create, Return, Update and Delete the entities managed (e.g. create(...))
  2. various finder methods: query methods to return the entities managed, by various criteria (e.g. findTrackerItemsByTracker(...))
  3. other entity-specific operations (e.g. locking for artifacts)
You will notice that most of the methods require passing a UserDto instance. This represents the currently signed in user and is used by security checks and auditing.

Note that the Service Layer is CodeBeamer's actual "internal" API. Practically, it means that if you program against this interface, your code will not be vulnerable for future changes.

This interface is designed to be used inside CodeBeamer, typically when developing a custom event listener or custom wiki plugin. However, technically it is possible to interact with other lower-level CodeBeamer components (like calling the DAOs or working directly with the database), it is strongly discouraged, as it will very likely hurt data integrity and security rules.

For more details, documentation and tutorials related to CodeBeamer's Service Layer, please visit the CodeBeamer project at www.codebeamer.com.


CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.