blackboard.platform.dataintegration.mapping
Class DataIntegrationAttributeMapping

java.lang.Object
  extended by blackboard.data.AbstractIdentifiable
      extended by blackboard.platform.dataintegration.mapping.DataIntegrationAttributeMapping
All Implemented Interfaces:
Identifiable

public class DataIntegrationAttributeMapping
extends blackboard.data.AbstractIdentifiable

Represents a mapping between an attribute in a Learn object and a mapping script that transforms incoming data.

Since:
Bb 9.1 SP6

Nested Class Summary
static class DataIntegrationAttributeMapping.InvalidDataRule
           
 
Field Summary
static DataType DATA_TYPE
           
 
Constructor Summary
DataIntegrationAttributeMapping()
           
 
Method Summary
 java.lang.String getAttributeName()
          Get the name of the Learn object attribute.
 java.lang.String getCustomScript()
          Get the text of the custom (user editable) script.
 Id getDataIntegrationObjectId()
          Get the Id of the DataIntegrationObjectMapping that this attribute mapping belongs to.
 DataIntegrationAttributeMapping.InvalidDataRule getInvalidDataRule()
          Get the rule for what will happen when invalid data is returned from the mapping script.
 java.lang.String getScriptName()
          Get the name of the built-in mapping script (either provided by the DataIntegrationSISObjectType or the core API.
 boolean isUpdatedOnChange()
          Get whether this attribute should be updated during an update operation or left alone
 void setAttributeName(java.lang.String attributeName)
          Set the name of the Learn object attribute.
 void setCustomScript(java.lang.String customScript)
          Set the text of the custom (user editable) script.
 void setDataIntegrationObjectId(Id dataIntegrationObjectId)
          Set the Id of the DataIntegrationObjectMapping that this attribute mapping belongs to.
 void setInvalidDataRule(DataIntegrationAttributeMapping.InvalidDataRule invalidDataRule)
          Set the rule for what will happen when invalid data is returned from the mapping script.'
 void setScriptName(java.lang.String scriptName)
          Set the name of the built-in mapping script (either provided by the DataIntegrationSISObjectType or the core API.
 void setUpdatedOnChange(boolean isUpdatedOnChange)
          Set whether this attribute should be updated during an update operation or left alone.
 
Methods inherited from class blackboard.data.AbstractIdentifiable
equals, getDataType, getId, getMaxLength, hashCode, setId, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE
Constructor Detail

DataIntegrationAttributeMapping

public DataIntegrationAttributeMapping()
Method Detail

getDataIntegrationObjectId

public Id getDataIntegrationObjectId()
Get the Id of the DataIntegrationObjectMapping that this attribute mapping belongs to.

Returns:
The object mapping Id.

setDataIntegrationObjectId

public void setDataIntegrationObjectId(Id dataIntegrationObjectId)
Set the Id of the DataIntegrationObjectMapping that this attribute mapping belongs to.

Parameters:
dataIntegrationObjectId - The object mapping id.

getAttributeName

public java.lang.String getAttributeName()
Get the name of the Learn object attribute.

Returns:
The attribute name.

setAttributeName

public void setAttributeName(java.lang.String attributeName)
Set the name of the Learn object attribute.

Parameters:
attributeName - The attribute name.

isUpdatedOnChange

public boolean isUpdatedOnChange()
Get whether this attribute should be updated during an update operation or left alone

Returns:
Whether this attribute should be changed on update.

setUpdatedOnChange

public void setUpdatedOnChange(boolean isUpdatedOnChange)
Set whether this attribute should be updated during an update operation or left alone.

Parameters:
isUpdatedOnChange - Whether this attribute should be changed on update.

getInvalidDataRule

public DataIntegrationAttributeMapping.InvalidDataRule getInvalidDataRule()
Get the rule for what will happen when invalid data is returned from the mapping script.

Returns:
The invalid data rule.

setInvalidDataRule

public void setInvalidDataRule(DataIntegrationAttributeMapping.InvalidDataRule invalidDataRule)
Set the rule for what will happen when invalid data is returned from the mapping script.'

Parameters:
invalidDataRule - The invalid data rule.

getScriptName

public java.lang.String getScriptName()
Get the name of the built-in mapping script (either provided by the DataIntegrationSISObjectType or the core API.

Returns:
The script name.

setScriptName

public void setScriptName(java.lang.String scriptName)
Set the name of the built-in mapping script (either provided by the DataIntegrationSISObjectType or the core API.

Parameters:
scriptName - The script name.

getCustomScript

public java.lang.String getCustomScript()
Get the text of the custom (user editable) script. The script is written in JavaScript.

Returns:
The text of the custom (user editable) script.

setCustomScript

public void setCustomScript(java.lang.String customScript)
Set the text of the custom (user editable) script. The script is written in JavaScript.

Parameters:
customScript - The text of the custom (user editable) script.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.