Interface DataCompositionDataSetFieldRole
- 
- All Superinterfaces:
- org.eclipse.emf.ecore.EObject,- org.eclipse.emf.common.notify.Notifier
 - All Known Implementing Classes:
- DataCompositionDataSetFieldRoleImpl
 
 public interface DataCompositionDataSetFieldRole extends org.eclipse.emf.ecore.EObjectA representation of the model object 'Data Composition Data Set Field Role'.The following features are supported: 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAccountField()Returns the value of the 'Account Field' attribute.DataCompositionAccountingBalanceTypegetAccountingBalanceType()Returns the value of the 'Accounting Balance Type' attribute.StringgetAccountTypeExpression()Returns the value of the 'Account Type Expression' attribute.StringgetBalanceGroupName()Returns the value of the 'Balance Group Name' attribute.DataCompositionBalanceTypegetBalanceType()Returns the value of the 'Balance Type' attribute.StringgetParentDimension()Returns the value of the 'Parent Dimension' attribute.intgetPeriodNumber()Returns the value of the 'Period Number' attribute.DataCompositionPeriodTypegetPeriodType()Returns the value of the 'Period Type' attribute.booleanisAccount()Returns the value of the 'Account' attribute.booleanisBalance()Returns the value of the 'Balance' attribute.booleanisDimension()Returns the value of the 'Dimension' attribute.booleanisDimensionAttribute()Returns the value of the 'Dimension Attribute' attribute.booleanisIgnoreNullValues()Returns the value of the 'Ignore Null Values' attribute.booleanisRequired()Returns the value of the 'Required' attribute.voidsetAccount(boolean value)Sets the value of the 'Account' attribute.voidsetAccountField(String value)Sets the value of the 'Account Field' attribute.voidsetAccountingBalanceType(DataCompositionAccountingBalanceType value)Sets the value of the 'Accounting Balance Type' attribute.voidsetAccountTypeExpression(String value)Sets the value of the 'Account Type Expression' attribute.voidsetBalance(boolean value)Sets the value of the 'Balance' attribute.voidsetBalanceGroupName(String value)Sets the value of the 'Balance Group Name' attribute.voidsetBalanceType(DataCompositionBalanceType value)Sets the value of the 'Balance Type' attribute.voidsetDimension(boolean value)Sets the value of the 'Dimension' attribute.voidsetDimensionAttribute(boolean value)Sets the value of the 'Dimension Attribute' attribute.voidsetIgnoreNullValues(boolean value)Sets the value of the 'Ignore Null Values' attribute.voidsetParentDimension(String value)Sets the value of the 'Parent Dimension' attribute.voidsetPeriodNumber(int value)Sets the value of the 'Period Number' attribute.voidsetPeriodType(DataCompositionPeriodType value)Sets the value of the 'Period Type' attribute.voidsetRequired(boolean value)Sets the value of the 'Required' attribute.
 
- 
- 
- 
Method Detail- 
getPeriodNumberint getPeriodNumber() Returns the value of the 'Period Number' attribute. The default value is"0".- Returns:
- the value of the 'Period Number' attribute.
- See Also:
- setPeriodNumber(int),- DcsPackage.getDataCompositionDataSetFieldRole_PeriodNumber()
 
 - 
setPeriodNumbervoid setPeriodNumber(int value) Sets the value of the 'Period Number' attribute.- Parameters:
- value- the new value of the 'Period Number' attribute.
- See Also:
- getPeriodNumber()
 
 - 
getPeriodTypeDataCompositionPeriodType getPeriodType() Returns the value of the 'Period Type' attribute. The default value is"Main". The literals are from the enumerationDataCompositionPeriodType.- Returns:
- the value of the 'Period Type' attribute.
- See Also:
- DataCompositionPeriodType,- setPeriodType(DataCompositionPeriodType),- DcsPackage.getDataCompositionDataSetFieldRole_PeriodType()
 
 - 
setPeriodTypevoid setPeriodType(DataCompositionPeriodType value) Sets the value of the 'Period Type' attribute.- Parameters:
- value- the new value of the 'Period Type' attribute.
- See Also:
- DataCompositionPeriodType,- getPeriodType()
 
 - 
isDimensionboolean isDimension() Returns the value of the 'Dimension' attribute. The default value is"false".- Returns:
- the value of the 'Dimension' attribute.
- See Also:
- setDimension(boolean),- DcsPackage.getDataCompositionDataSetFieldRole_Dimension()
 
 - 
setDimensionvoid setDimension(boolean value) Sets the value of the 'Dimension' attribute.- Parameters:
- value- the new value of the 'Dimension' attribute.
- See Also:
- isDimension()
 
 - 
getParentDimensionString getParentDimension() Returns the value of the 'Parent Dimension' attribute.- Returns:
- the value of the 'Parent Dimension' attribute.
- See Also:
- setParentDimension(String),- DcsPackage.getDataCompositionDataSetFieldRole_ParentDimension()
 
 - 
setParentDimensionvoid setParentDimension(String value) Sets the value of the 'Parent Dimension' attribute.- Parameters:
- value- the new value of the 'Parent Dimension' attribute.
- See Also:
- getParentDimension()
 
 - 
isAccountboolean isAccount() Returns the value of the 'Account' attribute. The default value is"false".- Returns:
- the value of the 'Account' attribute.
- See Also:
- setAccount(boolean),- DcsPackage.getDataCompositionDataSetFieldRole_Account()
 
 - 
setAccountvoid setAccount(boolean value) Sets the value of the 'Account' attribute.- Parameters:
- value- the new value of the 'Account' attribute.
- See Also:
- isAccount()
 
 - 
getAccountTypeExpressionString getAccountTypeExpression() Returns the value of the 'Account Type Expression' attribute.- Returns:
- the value of the 'Account Type Expression' attribute.
- See Also:
- setAccountTypeExpression(String),- DcsPackage.getDataCompositionDataSetFieldRole_AccountTypeExpression()
 
 - 
setAccountTypeExpressionvoid setAccountTypeExpression(String value) Sets the value of the 'Account Type Expression' attribute.- Parameters:
- value- the new value of the 'Account Type Expression' attribute.
- See Also:
- getAccountTypeExpression()
 
 - 
isBalanceboolean isBalance() Returns the value of the 'Balance' attribute. The default value is"false".- Returns:
- the value of the 'Balance' attribute.
- See Also:
- setBalance(boolean),- DcsPackage.getDataCompositionDataSetFieldRole_Balance()
 
 - 
setBalancevoid setBalance(boolean value) Sets the value of the 'Balance' attribute.- Parameters:
- value- the new value of the 'Balance' attribute.
- See Also:
- isBalance()
 
 - 
getBalanceGroupNameString getBalanceGroupName() Returns the value of the 'Balance Group Name' attribute.- Returns:
- the value of the 'Balance Group Name' attribute.
- See Also:
- setBalanceGroupName(String),- DcsPackage.getDataCompositionDataSetFieldRole_BalanceGroupName()
 
 - 
setBalanceGroupNamevoid setBalanceGroupName(String value) Sets the value of the 'Balance Group Name' attribute.- Parameters:
- value- the new value of the 'Balance Group Name' attribute.
- See Also:
- getBalanceGroupName()
 
 - 
getBalanceTypeDataCompositionBalanceType getBalanceType() Returns the value of the 'Balance Type' attribute. The default value is"None". The literals are from the enumerationDataCompositionBalanceType.- Returns:
- the value of the 'Balance Type' attribute.
- See Also:
- DataCompositionBalanceType,- setBalanceType(DataCompositionBalanceType),- DcsPackage.getDataCompositionDataSetFieldRole_BalanceType()
 
 - 
setBalanceTypevoid setBalanceType(DataCompositionBalanceType value) Sets the value of the 'Balance Type' attribute.- Parameters:
- value- the new value of the 'Balance Type' attribute.
- See Also:
- DataCompositionBalanceType,- getBalanceType()
 
 - 
getAccountingBalanceTypeDataCompositionAccountingBalanceType getAccountingBalanceType() Returns the value of the 'Accounting Balance Type' attribute. The default value is"None". The literals are from the enumerationDataCompositionAccountingBalanceType.- Returns:
- the value of the 'Accounting Balance Type' attribute.
- See Also:
- DataCompositionAccountingBalanceType,- setAccountingBalanceType(DataCompositionAccountingBalanceType),- DcsPackage.getDataCompositionDataSetFieldRole_AccountingBalanceType()
 
 - 
setAccountingBalanceTypevoid setAccountingBalanceType(DataCompositionAccountingBalanceType value) Sets the value of the 'Accounting Balance Type' attribute.- Parameters:
- value- the new value of the 'Accounting Balance Type' attribute.
- See Also:
- DataCompositionAccountingBalanceType,- getAccountingBalanceType()
 
 - 
getAccountFieldString getAccountField() Returns the value of the 'Account Field' attribute.- Returns:
- the value of the 'Account Field' attribute.
- See Also:
- setAccountField(String),- DcsPackage.getDataCompositionDataSetFieldRole_AccountField()
 
 - 
setAccountFieldvoid setAccountField(String value) Sets the value of the 'Account Field' attribute.- Parameters:
- value- the new value of the 'Account Field' attribute.
- See Also:
- getAccountField()
 
 - 
isIgnoreNullValuesboolean isIgnoreNullValues() Returns the value of the 'Ignore Null Values' attribute. The default value is"false".- Returns:
- the value of the 'Ignore Null Values' attribute.
- See Also:
- setIgnoreNullValues(boolean),- DcsPackage.getDataCompositionDataSetFieldRole_IgnoreNullValues()
 
 - 
setIgnoreNullValuesvoid setIgnoreNullValues(boolean value) Sets the value of the 'Ignore Null Values' attribute.- Parameters:
- value- the new value of the 'Ignore Null Values' attribute.
- See Also:
- isIgnoreNullValues()
 
 - 
isRequiredboolean isRequired() Returns the value of the 'Required' attribute. The default value is"false".- Returns:
- the value of the 'Required' attribute.
- See Also:
- setRequired(boolean),- DcsPackage.getDataCompositionDataSetFieldRole_Required()
 
 - 
setRequiredvoid setRequired(boolean value) Sets the value of the 'Required' attribute.- Parameters:
- value- the new value of the 'Required' attribute.
- See Also:
- isRequired()
 
 - 
isDimensionAttributeboolean isDimensionAttribute() Returns the value of the 'Dimension Attribute' attribute. The default value is"false".- Returns:
- the value of the 'Dimension Attribute' attribute.
- See Also:
- setDimensionAttribute(boolean),- DcsPackage.getDataCompositionDataSetFieldRole_DimensionAttribute()
 
 - 
setDimensionAttributevoid setDimensionAttribute(boolean value) Sets the value of the 'Dimension Attribute' attribute.- Parameters:
- value- the new value of the 'Dimension Attribute' attribute.
- See Also:
- isDimensionAttribute()
 
 
- 
 
-