com.novell.application.console.snapin.scope
Interface Scope

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GlobalScope, GlobalViewScope, MultiSelectNamespaceBaseTypeScope, NamespaceContainerTypesScope, NamespaceLeafTypesScope, NamespaceMultiSelectPopupMenuScope, NamespaceTreeObjectsScope, NamespaceTypeScope, NamespaceViewScope, PreferenceScope, MultiSelectNamespaceScope, NamespaceScope

public interface Scope

extends java.io.Serializable

Provides the interface that must be implemented by all scope classes, and from which all scope classes derive.

The scope classes derived from this base class are used by the various snap-in types to obtain information identifying the registration point for the participating snap-in being registered. Following is a table of derived scopes with the snap-in types available for each. The abbreviations in the table for the scope classes are as follows:

• GS = GlobalScope
• GTS = GlobalTypeScope
• GCTS = GlobalContainerTypesScope
• GLTS = GlobalLeafTypesScope
• GTOS = GlobalTreeObjectsScope
• GVS = GlobalViewScope
• NS = NamespaceScope
• NTS = NamespaceTypeScope
• NCTS = NamespaceContainerTypesScope
• NLTS = NamespaceLeafTypesScope
• NTOS = NamespaceTreeObjectsScope
• NVS = NamespaceViewScope
• NMPS = NamespaceMultiSelectPopupMenuScope

Available Snap-in Types for Defined Snap-in Scopes

Snap-in Type

GS

GTS

GTCS

GTLS

GTOS

GVS

NS

NTS

NCTS

NLTS

NTOS

NVS

NMPS

Page

X

X

X

X

X

X

X

X

View

X

X

X

X

X

X

X

X

X

X

Menu

X

X

X

X

Toolbar

X

X

X

X

Status Bar

X

X

X

X

Service

X

Namespace

X

Display Name

X

X

X

Display Icon

X

X

X

Pop-up Menu

X

X

X

X

X

X

X

X

X

X

X

Persistence

X

See Also:

GlobalScope, GlobalViewScope, MultiSelectNamespaceBaseTypeScope, MultiSelectNamespaceScope, NamespaceContainerTypesScope, NamespaceLeafTypesScope, NamespaceMultiSelectPopupMenuScope, NamespaceScope, NamespaceTreeObjectsScope, NamespaceTypeScope, NamespaceViewScope

Method Summary

java.lang.String	getScopeDescription() Returns the scope description for this registration point.
java.lang.String	getScopeKey() Returns the scope string for this registration point.
java.lang.Object	getSnapinType() Returns the snap-in type as an object.

Method Detail

getScopeKey

public java.lang.String getScopeKey()

Returns the scope string for this registration point.

The getScopeKey() method is called by the RegistrationItem class.

Returns:

The scope string.

getScopeDescription

public java.lang.String getScopeDescription()

Returns the scope description for this registration point.

The getScopeDescription() method is called by the ConsoleOne Configurator.

Returns:

The scope description string.

getSnapinType

public java.lang.Object getSnapinType()

Returns the snap-in type as an object.

Returns:

The snap-in type object.