blackboard.platform.dataintegration.mapping
Interface DataIntegrationSISObjectType

public interface DataIntegrationSISObjectType

Extension point for SIS Object Types.

Building blocks should implement this extension for each type of data the integration provides.

Since:

Bb 9.1 SP6

Field Summary

static java.lang.String

EXTENSION_POINT

Method Summary

java.util.Map<java.lang.String,DataIntegrationAttributeMapping>	getDefaultAttributeMappings(java.lang.String learnObjectType, DataIntegration dataIntegration) Return a list of (new, unpersisted) DataIntegrationAttributeMapping objects for the default attribute mapping for the specified learnObjectType The dataIntegrationObjectId doesn't need to be set on the returned objects.
java.lang.String	getDisplayName() Get the localized display name for the object type.
java.util.List<DataIntegrationDocument>	getDocumentation() Get any documentation specific to this SIS object.
java.lang.String	getMappingScript(java.lang.String scriptName) Gets the contents of the mapping script having the specified name.
java.util.List<MappingScriptMetadata>	getMappingScriptMetadata() Returns a list of metadata for the built-in mapping scripts applicable for this SIS object type.
java.lang.String	getType() Return the fully qualified name of the extension.

Field Detail

EXTENSION_POINT

static final java.lang.String EXTENSION_POINT

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()

Return the fully qualified name of the extension.

E.g. "blackboard.platform.myIntegrationSISObjectType"

getDisplayName

java.lang.String getDisplayName()

Get the localized display name for the object type.

getDocumentation

java.util.List<DataIntegrationDocument> getDocumentation()

Get any documentation specific to this SIS object.

getDefaultAttributeMappings

java.util.Map<java.lang.String,DataIntegrationAttributeMapping> getDefaultAttributeMappings(java.lang.String learnObjectType,
                                                                                            DataIntegration dataIntegration)

Return a list of (new, unpersisted) DataIntegrationAttributeMapping objects for the default attribute mapping for the specified learnObjectType

The dataIntegrationObjectId doesn't need to be set on the returned objects.

Should return null if there are no default attribute mappings.

Parameters:

learnObjectType - the type of the DataIntegrationLearnObjectType the attribute mappings should be for.

dataIntegration - the data integration that these mappings will be for.

getMappingScriptMetadata

java.util.List<MappingScriptMetadata> getMappingScriptMetadata()

Returns a list of metadata for the built-in mapping scripts applicable for this SIS object type. This is used to populate dropdowns to select scripts on the field mapping page.

Should return null if there are no built in mapping scripts.

The localized values inside the metadata should be displayed based on the current locale in Context.

Returns:

a List of MappingScriptMetadata for the built-in mapping scripts applicable for this SIS object type.

getMappingScript

java.lang.String getMappingScript(java.lang.String scriptName)

Gets the contents of the mapping script having the specified name.

This is used when executing the scripts during the mapping process.

Parameters:

scriptName - The unique id of the script

Returns:

The script, or null if there is no such script.