ITableProperties (OpenL - DEV - Engine 5.22.6 API)

All Known Implementing Classes:

TableProperties
```
public interface ITableProperties
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Boolean`	`getActive()`
`Map<String,Object>`	`getAllDimensionalProperties()` Gets the `Map` of properties with name as key and value as value, this map contains all dimensional properties defined for table.
`Map<String,Object>`	`getAllProperties()` `Map` of properties that includes all properties for current table.
`Boolean`	`getAutoType()`
`String`	`getBuildPhase()`
`Boolean`	`getCacheable()`
`Boolean`	`getCalculateAllCells()`
`CaProvincesEnum[]`	`getCaProvinces()`
`CaRegionsEnum[]`	`getCaRegions()`
`String`	`getCategory()`
`Map<String,Object>`	`getCategoryProperties()` `Map` of properties applied to the category this table belongs to.
`TableSyntaxNode`	`getCategoryPropertiesTableSyntaxNode()`
`CountriesEnum[]`	`getCountry()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`CurrenciesEnum[]`	`getCurrency()`
`String`	`getCurrentTableType()`
`String`	`getDatatypePackage()`
`Map<String,Object>`	`getDefaultProperties()` `Map` of properties that must be set by default.
`String`	`getDescription()`
`Date`	`getEffectiveDate()`
`Date`	`getEndRequestDate()`
`Date`	`getExpirationDate()`
`Map<String,Object>`	`getExternalProperties()`
`Boolean`	`getFailOnMiss()`
`String`	`getId()`
`TableSyntaxNode`	`getInheritedPropertiesTableSyntaxNode(InheritanceLevel inheritanceLevel)`
`LanguagesEnum[]`	`getLang()`
`String[]`	`getLob()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`Map<String,Object>`	`getModuleProperties()` `Map` of properties applied to the module this table belongs to.
`TableSyntaxNode`	`getModulePropertiesTableSyntaxNode()`
`String`	`getName()`
`String`	`getNature()`
`OriginsEnum`	`getOrigin()`
`Boolean`	`getParallel()`
`String`	`getPrecision()`
`ILogicalTable`	`getPropertiesSection()` Gets the logical table of the properties defined in table.
`InheritanceLevel`	`getPropertyLevelDefinedOn(String propertyName)` Goes through the hierarchy of properties from TABLE to CATEGORY and then to MODULE and returns the level on which property is inherited or defined.
`Object`	`getPropertyValue(String propertyName)` Gets the value of the property by its name.
`String`	`getPropertyValueAsString(String propertyName)` Returns the value of the property as `String`.
`RecalculateEnum`	`getRecalculate()`
`RegionsEnum[]`	`getRegion()`
`String`	`getScope()`
`Date`	`getStartRequestDate()`
`UsStatesEnum[]`	`getState()`
`Map<String,Object>`	`getTableProperties()` Gets the `Map` of properties with name as key and value as value, this map contains all properties defined in source table.
`String[]`	`getTags()`
`UsRegionsEnum[]`	`getUsregion()`
`ValidateDTEnum`	`getValidateDT()`
`String`	`getVersion()`
`boolean`	`isPropertiesEmpty()` Checks that current table doesn't have properties.
`boolean`	`isPropertyAppliedByDefault(String propertyName)` Check if the property with given name is applied for current table by default.
`void`	`setActive(Boolean active)`
`void`	`setAutoType(Boolean autoType)`
`void`	`setBuildPhase(String buildPhase)`
`void`	`setCacheable(Boolean cacheable)`
`void`	`setCalculateAllCells(Boolean calculateAllCells)`
`void`	`setCaProvinces(CaProvincesEnum... caProvinces)`
`void`	`setCaRegions(CaRegionsEnum... caRegions)`
`void`	`setCategory(String category)`
`void`	`setCategoryProperties(Map<String,Object> categoryProperties)`
`void`	`setCategoryPropertiesTableSyntaxNode(TableSyntaxNode categoryPropertiesTableSyntaxNode)`
`void`	`setCountry(CountriesEnum... country)`
`void`	`setCreatedBy(String createdBy)`
`void`	`setCreatedOn(Date createdOn)`
`void`	`setCurrency(CurrenciesEnum... currency)`
`void`	`setCurrentTableType(String currentTableType)`
`void`	`setDatatypePackage(String datatypePackage)`
`void`	`setDefaultProperties(Map<String,Object> defaultProperties)`
`void`	`setDescription(String description)`
`void`	`setEffectiveDate(Date effectiveDate)`
`void`	`setEndRequestDate(Date endRequestDate)`
`void`	`setExpirationDate(Date expirationDate)`
`void`	`setExternalProperties(Map<String,Object> moduleProperties)`
`void`	`setFailOnMiss(Boolean failOnMiss)`
`void`	`setId(String id)`
`void`	`setLang(LanguagesEnum... lang)`
`void`	`setLob(String... lob)`
`void`	`setModifiedBy(String modifiedBy)`
`void`	`setModifiedOn(Date modifiedOn)`
`void`	`setModuleProperties(Map<String,Object> moduleProperties)`
`void`	`setModulePropertiesTableSyntaxNode(TableSyntaxNode modulePropertiesTableSyntaxNode)`
`void`	`setName(String name)`
`void`	`setNature(String nature)`
`void`	`setOrigin(OriginsEnum origin)`
`void`	`setParallel(Boolean parallel)`
`void`	`setPrecision(String precision)`
`void`	`setPropertiesSection(ILogicalTable propertySection)`
`void`	`setRecalculate(RecalculateEnum recalculate)`
`void`	`setRegion(RegionsEnum... region)`
`void`	`setScope(String scope)`
`void`	`setStartRequestDate(Date startRequestDate)`
`void`	`setState(UsStatesEnum... state)`
`void`	`setTags(String... tags)`
`void`	`setUsregion(UsRegionsEnum... usregion)`
`void`	`setValidateDT(ValidateDTEnum validateDT)`
`void`	`setVersion(String version)`

- Method Detail
  - getAllProperties
```
Map<String,Object> getAllProperties()
```
    Map of properties that includes all properties for current table. It includes: - all properties physically defined in table with system ones; - inherited properties from category and module scopes; - properties set by default;
    
    Returns:
    
    Map of all properties relevant to current table.
  - getTableProperties
```
Map<String,Object> getTableProperties()
```
    Gets the Map of properties with name as key and value as value, this map contains all properties defined in source table. No inherited and no default properties.
    
    Returns:
    
    Map of properties defined in table.
  - getAllDimensionalProperties
```
Map<String,Object> getAllDimensionalProperties()
```
    Gets the Map of properties with name as key and value as value, this map contains all dimensional properties defined for table. To find out which property is dimensional see property definitions TablePropertyDefinitionUtils.getSystemProperties().
    
    Returns:
    
    Map of properties defined in table excluding system properties.
  - getCategoryProperties
```
Map<String,Object> getCategoryProperties()
```
    Map of properties applied to the category this table belongs to.
    
    Returns:
    
    Map of properties applied to the category this table belongs to.
  - getModuleProperties
```
Map<String,Object> getModuleProperties()
```
    Map of properties applied to the module this table belongs to.
    
    Returns:
    
    Map of properties applied to the module this table belongs to.
  - getExternalProperties
```
Map<String,Object> getExternalProperties()
```
  - getDefaultProperties
```
Map<String,Object> getDefaultProperties()
```
    Map of properties that must be set by default. Default properties are set to the table when there is no such property defined on TABLE, CATEGORY and MODULE levels. To find out which property is default see property definitions TablePropertyDefinitionUtils.getSystemProperties().
    
    Returns:
    
    Map of properties that must be set by default.
  - getPropertyValue
```
Object getPropertyValue(String propertyName)
```
    Gets the value of the property by its name.
    
    Parameters:
    
    propertyName - Property name.
    
    Returns:
    
    Property value.
  - getPropertyValueAsString
```
String getPropertyValueAsString(String propertyName)
```
    Returns the value of the property as String. If the current property value is of Date type, gets the format of date from DefaultPropertyDefinitions.
    
    Parameters:
    
    propertyName - Name of the property.
    
    Returns:
    
    Value formatted to string. Null when there is no property with such name.
  - getPropertiesSection
```
ILogicalTable getPropertiesSection()
```
    Gets the logical table of the properties defined in table.
  - setPropertiesSection
```
void setPropertiesSection(ILogicalTable propertySection)
```
  - getModulePropertiesTableSyntaxNode
```
TableSyntaxNode getModulePropertiesTableSyntaxNode()
```
  - setModulePropertiesTableSyntaxNode
```
void setModulePropertiesTableSyntaxNode(TableSyntaxNode modulePropertiesTableSyntaxNode)
```
  - getCategoryPropertiesTableSyntaxNode
```
TableSyntaxNode getCategoryPropertiesTableSyntaxNode()
```
  - setCategoryPropertiesTableSyntaxNode
```
void setCategoryPropertiesTableSyntaxNode(TableSyntaxNode categoryPropertiesTableSyntaxNode)
```
  - getInheritedPropertiesTableSyntaxNode
```
TableSyntaxNode getInheritedPropertiesTableSyntaxNode(InheritanceLevel inheritanceLevel)
```
  - getPropertyLevelDefinedOn
```
InheritanceLevel getPropertyLevelDefinedOn(String propertyName)
```
    Goes through the hierarchy of properties from TABLE to CATEGORY and then to MODULE and returns the level on which property is inherited or defined.
    
    Parameters:
    
    propertyName - Name of the property.
    
    Returns:
    
    level on which property is defined. NULL when there is no such property on all these levels. Or it can be set by default. So check is it applied as default. @see {@link #isPropertyAppliedByDefault(String)
  - isPropertyAppliedByDefault
```
boolean isPropertyAppliedByDefault(String propertyName)
```
    Check if the property with given name is applied for current table by default.
    
    Parameters:
    
    propertyName - name of the property.
    
    Returns:
    
    TRUE if the property with given name is applied for current table by default.
  - isPropertiesEmpty
```
boolean isPropertiesEmpty()
```
    Checks that current table doesn't have properties.
    
    Returns:
  - getName
```
String getName()
```
  - setName
```
void setName(String name)
```
  - getCategory
```
String getCategory()
```
  - setCategory
```
void setCategory(String category)
```
  - getCreatedBy
```
String getCreatedBy()
```
  - setCreatedBy
```
void setCreatedBy(String createdBy)
```
  - getCreatedOn
```
Date getCreatedOn()
```
  - setCreatedOn
```
void setCreatedOn(Date createdOn)
```
  - getModifiedBy
```
String getModifiedBy()
```
  - setModifiedBy
```
void setModifiedBy(String modifiedBy)
```
  - getModifiedOn
```
Date getModifiedOn()
```
  - setModifiedOn
```
void setModifiedOn(Date modifiedOn)
```
  - getDescription
```
String getDescription()
```
  - setDescription
```
void setDescription(String description)
```
  - getTags
```
String[] getTags()
```
  - setTags
```
void setTags(String... tags)
```
  - getEffectiveDate
```
Date getEffectiveDate()
```
  - setEffectiveDate
```
void setEffectiveDate(Date effectiveDate)
```
  - getExpirationDate
```
Date getExpirationDate()
```
  - setExpirationDate
```
void setExpirationDate(Date expirationDate)
```
  - getStartRequestDate
```
Date getStartRequestDate()
```
  - setStartRequestDate
```
void setStartRequestDate(Date startRequestDate)
```
  - getEndRequestDate
```
Date getEndRequestDate()
```
  - setEndRequestDate
```
void setEndRequestDate(Date endRequestDate)
```
  - getCaRegions
```
CaRegionsEnum[] getCaRegions()
```
  - setCaRegions
```
void setCaRegions(CaRegionsEnum... caRegions)
```
  - getCaProvinces
```
CaProvincesEnum[] getCaProvinces()
```
  - setCaProvinces
```
void setCaProvinces(CaProvincesEnum... caProvinces)
```
  - getCountry
```
CountriesEnum[] getCountry()
```
  - setCountry
```
void setCountry(CountriesEnum... country)
```
  - getRegion
```
RegionsEnum[] getRegion()
```
  - setRegion
```
void setRegion(RegionsEnum... region)
```
  - getCurrency
```
CurrenciesEnum[] getCurrency()
```
  - setCurrency
```
void setCurrency(CurrenciesEnum... currency)
```
  - getLang
```
LanguagesEnum[] getLang()
```
  - setLang
```
void setLang(LanguagesEnum... lang)
```
  - getLob
```
String[] getLob()
```
  - setLob
```
void setLob(String... lob)
```
  - getOrigin
```
OriginsEnum getOrigin()
```
  - setOrigin
```
void setOrigin(OriginsEnum origin)
```
  - getUsregion
```
UsRegionsEnum[] getUsregion()
```
  - setUsregion
```
void setUsregion(UsRegionsEnum... usregion)
```
  - getState
```
UsStatesEnum[] getState()
```
  - setState
```
void setState(UsStatesEnum... state)
```
  - getVersion
```
String getVersion()
```
  - setVersion
```
void setVersion(String version)
```
  - getActive
```
Boolean getActive()
```
  - setActive
```
void setActive(Boolean active)
```
  - getId
```
String getId()
```
  - setId
```
void setId(String id)
```
  - getBuildPhase
```
String getBuildPhase()
```
  - setBuildPhase
```
void setBuildPhase(String buildPhase)
```
  - getValidateDT
```
ValidateDTEnum getValidateDT()
```
  - setValidateDT
```
void setValidateDT(ValidateDTEnum validateDT)
```
  - getFailOnMiss
```
Boolean getFailOnMiss()
```
  - setFailOnMiss
```
void setFailOnMiss(Boolean failOnMiss)
```
  - getScope
```
String getScope()
```
  - setScope
```
void setScope(String scope)
```
  - getDatatypePackage
```
String getDatatypePackage()
```
  - setDatatypePackage
```
void setDatatypePackage(String datatypePackage)
```
  - getCacheable
```
Boolean getCacheable()
```
  - setCacheable
```
void setCacheable(Boolean cacheable)
```
  - getRecalculate
```
RecalculateEnum getRecalculate()
```
  - setRecalculate
```
void setRecalculate(RecalculateEnum recalculate)
```
  - getPrecision
```
String getPrecision()
```
  - setPrecision
```
void setPrecision(String precision)
```
  - getAutoType
```
Boolean getAutoType()
```
  - setAutoType
```
void setAutoType(Boolean autoType)
```
  - getCalculateAllCells
```
Boolean getCalculateAllCells()
```
  - setCalculateAllCells
```
void setCalculateAllCells(Boolean calculateAllCells)
```
  - getParallel
```
Boolean getParallel()
```
  - setParallel
```
void setParallel(Boolean parallel)
```
  - getNature
```
String getNature()
```
  - setNature
```
void setNature(String nature)
```
  - setCategoryProperties
```
void setCategoryProperties(Map<String,Object> categoryProperties)
```
  - setModuleProperties
```
void setModuleProperties(Map<String,Object> moduleProperties)
```
  - setExternalProperties
```
void setExternalProperties(Map<String,Object> moduleProperties)
```
  - setDefaultProperties
```
void setDefaultProperties(Map<String,Object> defaultProperties)
```
  - setCurrentTableType
```
void setCurrentTableType(String currentTableType)
```
  - getCurrentTableType
```
String getCurrentTableType()
```

Interface ITableProperties

Method Summary

Method Detail

getAllProperties

getTableProperties

getAllDimensionalProperties

getCategoryProperties

getModuleProperties

getExternalProperties

getDefaultProperties

getPropertyValue

getPropertyValueAsString

getPropertiesSection

setPropertiesSection

getModulePropertiesTableSyntaxNode

setModulePropertiesTableSyntaxNode

getCategoryPropertiesTableSyntaxNode

setCategoryPropertiesTableSyntaxNode

getInheritedPropertiesTableSyntaxNode

getPropertyLevelDefinedOn

isPropertyAppliedByDefault

isPropertiesEmpty

getName

setName

getCategory

setCategory

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

getDescription

setDescription

getTags

setTags

getEffectiveDate

setEffectiveDate

getExpirationDate

setExpirationDate

getStartRequestDate

setStartRequestDate

getEndRequestDate

setEndRequestDate

getCaRegions

setCaRegions

getCaProvinces

setCaProvinces

getCountry

setCountry

getRegion

setRegion

getCurrency

setCurrency

getLang

setLang

getLob

setLob

getOrigin

setOrigin

getUsregion

setUsregion

getState

setState

getVersion

setVersion

getActive

setActive

getId

setId

getBuildPhase

setBuildPhase

getValidateDT

setValidateDT

getFailOnMiss

setFailOnMiss

getScope

setScope