Package wt.sandbox

This package provides "sandbox" container functionality. A "sandbox" container is a container wherein a multiple users can work on a set of related changes through multiple iterations without disturbing the broader organization (apart from placing locks on the objects the broader organziation sees). The package provides the following core capabilities:

See:
Description

Class Summary

SandboxConflictType	Supported API: true Extendable: false
SandboxResolutionType	Supported API: true Extendable: false

Package wt.sandbox Description

This package provides "sandbox" container functionality. A "sandbox" container is a container wherein a multiple users can work on a set of related changes through multiple iterations without disturbing the broader organization (apart from placing locks on the objects the broader organziation sees). The package provides the following core capabilities:

• Check out business objects to a "sandbox" container as a separate (one-off-version) branch.
  
• Check such a business object back in as the next iteration on the branch the check out was performed against.
  
• Undo such a check out
  
• Check business objects created in a "sandbox" container into another container.

as well as related and supporting capabilities.

Although the various APIs in this package which target business objects take Versioned, Workable, WTReference, or collections thereof as arguments, the only business objects currently supported for sandbox check in and out are WTParts, WTDocuments, EPMDocuments, and subclasses thereof. The "getter" APIs (get* and is* methods) do, however, support the full breadth of the interfaces they take as arguments. Originally, the package has been implemented in as general a fashion as possible (making no unnecessary assumptions that the business objects it processed implemented any additional interfaces besides those noted in the method signatures), but the package is now optimized to require all business objects implement Workable, OneOffVersioned, and WTContained. Moreover some of the package specifically optimizes on the fact that the only supported business objects are WTParts, WTDocuments, EPMDocuments.

Similarly, various methods take WTContainerRef arguments where sandbox and other containers are involved, but only Project2 containers can be treated as sandbox containers -- and only non-Project2 (i.e. PDM) containers can be checked out from or checked in to. Some portions of the package have therefore been optimized to take advantage of these facts as well.