com.filenet.api.core

Interface Scope

All Known Subinterfaces:

Domain, InstantiatingScope, ObjectStore

public interface Scope

Defines the originating "scope" (enclosing context) of an object, such as the Domain of a Site or ObjectStore, or the ObjectStore of a Document.

Classes are generally characterized by where the instance objects reside. Some objects reside within an ObjectStore; other objects reside "above" an ObjectStore, that is, at a higher-level in the object model. The ClassDescription describes objects that reside somewhere. So, a ClassDescription is scoped to a particular location, and the object affiliated with that location is the scope object. Calling ClassDescription.getScope() returns one of the following, depending on what type of class the ClassDescription describes:

• Domain
• ObjectStore
• null (for the cases of Realm, EntireNetwork)

The following table lists scope objects and the objects scoped to them:

Scope Object	Types of scoped objects
EntireNetwork	EntireNetwork, Domain, Realm
Realm	User, Group
Domain	ObjectStore, MarkingSet, Site, VirtualServer, ServerInstance
ObjectStore	independent RepositoryObject types, ClassDescription

EntireNetwork, being the root of the hierarchy, scopes itself, and is also the scope object for Domain and Realm. The scope object for a ClassDescription object is the same as the scope object for an instance described by that ClassDescription. For example, if a CustomObject object is scoped by an ObjectStore instance "OS1", then the custom object's ClassDescription will also be scoped by "OS1".