com.ibm.xtools.mmi.core.services.ref

Interface IStructuredReferenceModifier

public interface IStructuredReferenceModifier

Defines methods used to create and modify StructuredReference.

Method Summary

Modifier and Type	Method and Description
void	addSupportingStructuredReference(StructuredReference structRef, StructuredReference supportingStructRef) Adds the supportingStructRef StructuredReference to the structRef StructuredReference, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.
StructuredReference	createStructuredReference(java.lang.String providerId, java.util.Map properties, StructuredReference[] supportingStructRefs) Creates a StructuredReference with the specified providerId, properties and supporting Structured References.
void	removeSupportingStructuredReference(StructuredReference structRef, int index) Removes the supporting StructuredReference at the specified index from the specified StructuredReference, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.
void	removeSupportingStructuredReference(StructuredReference structRef, StructuredReference supportingStructRef) Remove the specified supportingStructRef StructuredReference from the specified structRef StructuredReference, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.
void	setProperty(StructuredReference structRef, java.lang.String name, java.lang.String value) Adds or sets the property of the specified StructuredReference structRef, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.

Method Detail

createStructuredReference

StructuredReference createStructuredReference(java.lang.String providerId,
                                              java.util.Map properties,
                                              StructuredReference[] supportingStructRefs)

Creates a StructuredReference with the specified providerId, properties and supporting Structured References.

Parameters:

providerId - Provider Id of the Structured Reference to create

properties - Properties of the Structured Reference to create, null can be specified

supportingStructRefs - Supporting Structured References of the Structured Reference to create, null can be specified

Returns:

StructuredReference if the specified providerId is managed by this modifier, throws java.lang.AssertionError if providerId is null or not managed by this modifier.

setProperty

void setProperty(StructuredReference structRef,
                 java.lang.String name,
                 java.lang.String value)

Adds or sets the property of the specified StructuredReference structRef, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.

Parameters:

structRef - The StructuredReference to modify

name - Name of the property to set

value - Value of the property to set

addSupportingStructuredReference

void addSupportingStructuredReference(StructuredReference structRef,
                                      StructuredReference supportingStructRef)

Adds the supportingStructRef StructuredReference to the structRef StructuredReference, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.

Parameters:

structRef - The StructuredReference to modify

supportingStructRef - The supporting StructuredReference to

removeSupportingStructuredReference

void removeSupportingStructuredReference(StructuredReference structRef,
                                         int index)

Removes the supporting StructuredReference at the specified index from the specified StructuredReference, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.

Parameters:

structRef - The StructuredReference to modify

index - The index of the supporting StructuredReference to remove

removeSupportingStructuredReference

void removeSupportingStructuredReference(StructuredReference structRef,
                                         StructuredReference supportingStructRef)

Remove the specified supportingStructRef StructuredReference from the specified structRef StructuredReference, throws java.lang.AssertionError if the providerId of the structRef is not managed by this modifier.

Parameters:

structRef - The StructuredReference to modify

supportingStructRef - The StructuredReference to remove from the list of supporting StructuredReferneces