Package com.orchestranetworks.addon.igov

Classes and interfaces that get a node's label and description.

See: Description

Interface Summary

Interface	Description
IGovAdministeredItemListener	Defines methods which are extendable by child classes.
IGovLabeling	Provides methods for getting a node's label and description.

Class Summary

Class	Description
IGovLabelingContext	Defines the parameters needed when calling the {addon.label} labeling API.
IGovLabelingFactory	Factory for instances of IGovLabeling.
IGovLabelingSchemaDocumentation	Default class designed to work with the labeling API by extending SchemaDocumentation.

Exception Summary

Exception	Description
IGovException	Defines the exception for {addon.label}.

Package com.orchestranetworks.addon.igov Description

Classes and interfaces that get a node's label and description.

You can use the default IGovLabelingSchemaDocumentation to call the API without extending SchemaDocumentation by adding osd:documentation definition to the data model.

    <xs:annotation>
        <xs:appinfo>
            <osd:documentation class="com.orchestranetworks.addon.igov.IGovLabelingSchemaDocumentation" />
        </xs:appinfo>
    </xs:annotation>

You also can call IGovLabeling API by directly extending SchemaDocumentation.

        public class IGovLabelingSchemaDocumentation extends SchemaDocumentation
        {
                public String getLabel(SchemaDocumentationContext dContext)
                {
                        IGovLabeling labeling = IGovLabelingFactory.getInstance();
        
                        if (labeling == null)
                        {
                                return null;
                        }
        
                        return labeling.getLabel(new IGovLabelingContext(dContext));
                }
        
                public String getDescription(SchemaDocumentationContext dContext)
                {
                        IGovLabeling labeling = IGovLabelingFactory.getInstance();
        
                        if (labeling == null)
                        {
                                return null;
                        }
        
                        return labeling.getDescription(new IGovLabelingContext(dContext));
                }
        
                public void setup(SchemaDocumentationSetupContext context)
                {
                        //N.A
                }
        }