com.ibm.xsp.registry
Interface FacesSharableRegistry

All Superinterfaces:
com.ibm.xsp.registry.FacesReferenceContainer, FacesRegistry

public interface FacesSharableRegistry
extends FacesRegistry

The main API is FacesRegistry. To share registrys that depend on each other, so that you don't cause infinite loops, you have to allow a distinction between "everything visible from this registry, including in the dependencies" and "everything that is defined in this registry". These getLocal* methods show the those things defined within this registry, while the normal methods from FacesRegistry show everything in both this registry and it's dependencies.


Field Summary
static int TYPE_APPLICATION
          This registry contains the Custom Control xsp-configs in an application
static int TYPE_LIBRARY
          This registry corresponds to some library, but not a library that is part of the XPages runtime.
static int TYPE_OTHER
          An unidentified type of registy, the default type.
static int TYPE_RUNTIME
          This registry corresponds to a library that is part of the XPages runtime.
static int TYPE_STANDARD
           
 
Method Summary
 java.util.List<FacesComplexDefinition> findComplexLocalDefs()
           
 java.util.List<FacesComponentDefinition> findComponentLocalDefs()
           
 java.util.List<FacesCompositeComponentDefinition> findCompositeLocalDefs()
           
 java.util.List<FacesDefinition> findLocalDefs()
           
 java.util.List<FacesSharableRegistry> getDepends()
          The {FacesSharableRegistrys delegated to - an unmodifiable list.
 FacesLibrary getLocalLibrary(java.lang.String namespaceUri)
           
 java.util.Collection<java.lang.String> getLocalNamespaceUris()
           
 java.util.List<FacesProject> getLocalProjectList()
           
 java.util.Collection<java.lang.String> getLocalRenderKitIds()
          An unordered list of the ids of renderKits to which the local projects contribute fragments.
 FacesRenderKitLibrary getLocalRenderKitLibrary(java.lang.String renderKitId)
           
 int getRegistryType()
          Identifies which type of registry this is, what purpose it was created for.
 boolean isLocalDef(FacesDefinition def)
          True if this definition is local to this registry; not defined in one of the depends registrys.
 
Methods inherited from interface com.ibm.xsp.registry.FacesRegistry
findComplex, findComplexDefs, findComponent, findComponentDefs, findComposite, findCompositeDefs, findDef, findDef, findDefs, getId, getLibrary, getNamespaceUris, getProjectList, getRenderKitIds, getRenderKitLibrary, isNamespaceUri
 
Methods inherited from interface com.ibm.xsp.registry.FacesReferenceContainer
refreshReferences
 

Field Detail

TYPE_OTHER

static final int TYPE_OTHER
An unidentified type of registy, the default type.

See Also:
Constant Field Values

TYPE_LIBRARY

static final int TYPE_LIBRARY
This registry corresponds to some library, but not a library that is part of the XPages runtime.

See Also:
Constant Field Values

TYPE_RUNTIME

static final int TYPE_RUNTIME
This registry corresponds to a library that is part of the XPages runtime.

See Also:
Constant Field Values

TYPE_APPLICATION

static final int TYPE_APPLICATION
This registry contains the Custom Control xsp-configs in an application

See Also:
Constant Field Values

TYPE_STANDARD

static final int TYPE_STANDARD
See Also:
Constant Field Values
Method Detail

getDepends

java.util.List<FacesSharableRegistry> getDepends()
The {FacesSharableRegistrys delegated to - an unmodifiable list.


getLocalLibrary

FacesLibrary getLocalLibrary(java.lang.String namespaceUri)
Parameters:
namespaceUri -
Returns:
The library, if it exists, that has the specified namespace.

getLocalNamespaceUris

java.util.Collection<java.lang.String> getLocalNamespaceUris()

getLocalRenderKitLibrary

FacesRenderKitLibrary getLocalRenderKitLibrary(java.lang.String renderKitId)
Parameters:
renderKitId -
Returns:
The render kit library that corresponds to the specifies id.

getLocalRenderKitIds

java.util.Collection<java.lang.String> getLocalRenderKitIds()
An unordered list of the ids of renderKits to which the local projects contribute fragments.

Returns:

isLocalDef

boolean isLocalDef(FacesDefinition def)
True if this definition is local to this registry; not defined in one of the depends registrys.

Parameters:
def -
Returns:

findCompositeLocalDefs

java.util.List<FacesCompositeComponentDefinition> findCompositeLocalDefs()

findComponentLocalDefs

java.util.List<FacesComponentDefinition> findComponentLocalDefs()

findLocalDefs

java.util.List<FacesDefinition> findLocalDefs()

findComplexLocalDefs

java.util.List<FacesComplexDefinition> findComplexLocalDefs()

getLocalProjectList

java.util.List<FacesProject> getLocalProjectList()

getRegistryType

int getRegistryType()
Identifies which type of registry this is, what purpose it was created for. See the TYPE_* constants, like TYPE_RUNTIME. Also see RegistryUtil.getRegistryTypeName(FacesSharableRegistry) for the untranslated String type name.

Returns: