BiCollection (IBM Information Governance Catalog REST API Client Library 2.11 API)

java.lang.Object
- org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference
  - - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject
    - - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset
      - org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.BiCollection

```
public class BiCollection
extends InformationAsset
```
POJO for the bi_collection asset type in IGC, displayed as 'BI Collection' in the IGC UI.

(this code has been created based on out-of-the-box IGC metadata types. If modifications are needed, eg. to handle custom attributes, extending from this class in your own custom class is the best approach.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`aliasBusinessName`
`protected BiCollection`	`biCollection`
`protected ItemList<BiCollectionMember>`	`biCollectionMembers`
`protected ItemList<BiFilter>`	`biFilters`
`protected ItemList<BiHierarchy>`	`biHierarchies`
`protected ItemList<BiLevel>`	`biLevels`
`protected BiModel`	`biModel`
`protected ItemList<Olapobject>`	`biModelOrBiCollection`
`protected List<String>`	`filterExpression`
`protected ItemList<BiCollection>`	`hasOlapCollection`
`protected String`	`importedFrom`
`protected List<String>`	`joinCondition`
`protected String`	`namespace`
`protected ItemList<BiCollection>`	`referencedByBiCollection`
`protected ItemList<BiHierarchy>`	`referencedByBiHierarchies`
`protected ItemList<BiCollection>`	`referencesBiCollections`
`protected String`	`type`
`protected String`	`typeDefinition`
`protected ItemList<BiCube>`	`usedByBiCubes`
`protected ItemList<BiReportQuery>`	`usedByBiReportQueries`
`protected ItemList<Datagroup>`	`usesDatabaseTablesOrViews`

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset
blueprintElements, impactedBy, impactsOn, inCollections, nativeId, readByDesign, readByOperational, readByStatic, readByUserDefined, writtenByDesign, writtenByOperational, writtenByStatic, writtenByUserDefined

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject
assignedToTerms, governedByRules, implementsRules, labels, longDescription, name, shortDescription, stewards

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors
Constructor and Description

BiCollection()

Constructors
Constructor and Description
`BiCollection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAliasBusinessName()` Retrieve the `alias_(business_name)` property (displayed as 'Alias (Business Name)') of the object.
`BiCollection`	`getBiCollection()` Retrieve the `bi_collection` property (displayed as 'BI Collection') of the object.
`ItemList<BiCollectionMember>`	`getBiCollectionMembers()` Retrieve the `bi_collection_members` property (displayed as 'BI Collection Members') of the object.
`ItemList<BiFilter>`	`getBiFilters()` Retrieve the `bi_filters` property (displayed as 'BI Filters') of the object.
`ItemList<BiHierarchy>`	`getBiHierarchies()` Retrieve the `bi_hierarchies` property (displayed as 'BI Hierarchies') of the object.
`ItemList<BiLevel>`	`getBiLevels()` Retrieve the `bi_levels` property (displayed as 'BI Levels') of the object.
`BiModel`	`getBiModel()` Retrieve the `bi_model` property (displayed as 'BI Model') of the object.
`ItemList<Olapobject>`	`getBiModelOrBiCollection()` Retrieve the `bi_model_or_bi_collection` property (displayed as 'BI Model or BI Collection') of the object.
`List<String>`	`getFilterExpression()` Retrieve the `filter_expression` property (displayed as 'Filter Expression') of the object.
`ItemList<BiCollection>`	`getHasOlapCollection()` Retrieve the `has_olap_collection` property (displayed as 'Has OLAP Collection') of the object.
`String`	`getImportedFrom()` Retrieve the `imported_from` property (displayed as 'Imported From') of the object.
`List<String>`	`getJoinCondition()` Retrieve the `join_condition` property (displayed as 'Join Condition') of the object.
`String`	`getNamespace()` Retrieve the `namespace` property (displayed as 'Namespace') of the object.
`ItemList<BiCollection>`	`getReferencedByBiCollection()` Retrieve the `referenced_by_bi_collection` property (displayed as 'Referenced by BI Collection') of the object.
`ItemList<BiHierarchy>`	`getReferencedByBiHierarchies()` Retrieve the `referenced_by_bi_hierarchies` property (displayed as 'Referenced by BI Hierarchies') of the object.
`ItemList<BiCollection>`	`getReferencesBiCollections()` Retrieve the `references_bi_collections` property (displayed as 'References BI Collections') of the object.
`String`	`getTheType()` Retrieve the `type` property (displayed as 'Type') of the object.
`String`	`getTypeDefinition()` Retrieve the `type_definition` property (displayed as 'Type Definition') of the object.
`ItemList<BiCube>`	`getUsedByBiCubes()` Retrieve the `used_by_bi_cubes` property (displayed as 'Used by BI Cubes') of the object.
`ItemList<BiReportQuery>`	`getUsedByBiReportQueries()` Retrieve the `used_by_bi_report_queries` property (displayed as 'Used by BI Report Queries') of the object.
`ItemList<Datagroup>`	`getUsesDatabaseTablesOrViews()` Retrieve the `uses_database_tables_or_views` property (displayed as 'Uses Database Tables or Views') of the object.
`void`	`setAliasBusinessName(String aliasBusinessName)` Set the `alias_(business_name)` property (displayed as `Alias (Business Name)`) of the object.
`void`	`setBiCollection(BiCollection biCollection)` Set the `bi_collection` property (displayed as `BI Collection`) of the object.
`void`	`setBiCollectionMembers(ItemList<BiCollectionMember> biCollectionMembers)` Set the `bi_collection_members` property (displayed as `BI Collection Members`) of the object.
`void`	`setBiFilters(ItemList<BiFilter> biFilters)` Set the `bi_filters` property (displayed as `BI Filters`) of the object.
`void`	`setBiHierarchies(ItemList<BiHierarchy> biHierarchies)` Set the `bi_hierarchies` property (displayed as `BI Hierarchies`) of the object.
`void`	`setBiLevels(ItemList<BiLevel> biLevels)` Set the `bi_levels` property (displayed as `BI Levels`) of the object.
`void`	`setBiModel(BiModel biModel)` Set the `bi_model` property (displayed as `BI Model`) of the object.
`void`	`setBiModelOrBiCollection(ItemList<Olapobject> biModelOrBiCollection)` Set the `bi_model_or_bi_collection` property (displayed as `BI Model or BI Collection`) of the object.
`void`	`setFilterExpression(List<String> filterExpression)` Set the `filter_expression` property (displayed as `Filter Expression`) of the object.
`void`	`setHasOlapCollection(ItemList<BiCollection> hasOlapCollection)` Set the `has_olap_collection` property (displayed as `Has OLAP Collection`) of the object.
`void`	`setImportedFrom(String importedFrom)` Set the `imported_from` property (displayed as `Imported From`) of the object.
`void`	`setJoinCondition(List<String> joinCondition)` Set the `join_condition` property (displayed as `Join Condition`) of the object.
`void`	`setNamespace(String namespace)` Set the `namespace` property (displayed as `Namespace`) of the object.
`void`	`setReferencedByBiCollection(ItemList<BiCollection> referencedByBiCollection)` Set the `referenced_by_bi_collection` property (displayed as `Referenced by BI Collection`) of the object.
`void`	`setReferencedByBiHierarchies(ItemList<BiHierarchy> referencedByBiHierarchies)` Set the `referenced_by_bi_hierarchies` property (displayed as `Referenced by BI Hierarchies`) of the object.
`void`	`setReferencesBiCollections(ItemList<BiCollection> referencesBiCollections)` Set the `references_bi_collections` property (displayed as `References BI Collections`) of the object.
`void`	`setTheType(String type)` Set the `type` property (displayed as `Type`) of the object.
`void`	`setTypeDefinition(String typeDefinition)` Set the `type_definition` property (displayed as `Type Definition`) of the object.
`void`	`setUsedByBiCubes(ItemList<BiCube> usedByBiCubes)` Set the `used_by_bi_cubes` property (displayed as `Used by BI Cubes`) of the object.
`void`	`setUsedByBiReportQueries(ItemList<BiReportQuery> usedByBiReportQueries)` Set the `used_by_bi_report_queries` property (displayed as `Used by BI Report Queries`) of the object.
`void`	`setUsesDatabaseTablesOrViews(ItemList<Datagroup> usesDatabaseTablesOrViews)` Set the `uses_database_tables_or_views` property (displayed as `Uses Database Tables or Views`) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset
getBlueprintElements, getImpactedBy, getImpactsOn, getInCollections, getNativeId, getReadByDesign, getReadByOperational, getReadByStatic, getReadByUserDefined, getWrittenByDesign, getWrittenByOperational, getWrittenByStatic, getWrittenByUserDefined, setBlueprintElements, setImpactedBy, setImpactsOn, setInCollections, setNativeId, setReadByDesign, setReadByOperational, setReadByStatic, setReadByUserDefined, setWrittenByDesign, setWrittenByOperational, setWrittenByStatic, setWrittenByUserDefined

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject
getAssignedToTerms, getGovernedByRules, getImplementsRules, getLabels, getLongDescription, getShortDescription, getStewards, getTheName, setAssignedToTerms, setGovernedByRules, setImplementsRules, setLabels, setLongDescription, setShortDescription, setStewards, setTheName

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference
areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getName, getNotes, getType, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - aliasBusinessName
```
protected String aliasBusinessName
```
  - biCollection
```
protected BiCollection biCollection
```
  - biCollectionMembers
```
protected ItemList<BiCollectionMember> biCollectionMembers
```
  - biFilters
```
protected ItemList<BiFilter> biFilters
```
  - biHierarchies
```
protected ItemList<BiHierarchy> biHierarchies
```
  - biLevels
```
protected ItemList<BiLevel> biLevels
```
  - biModel
```
protected BiModel biModel
```
  - biModelOrBiCollection
```
protected ItemList<Olapobject> biModelOrBiCollection
```
  - filterExpression
```
protected List<String> filterExpression
```
  - hasOlapCollection
```
protected ItemList<BiCollection> hasOlapCollection
```
  - importedFrom
```
protected String importedFrom
```
  - joinCondition
```
protected List<String> joinCondition
```
  - namespace
```
protected String namespace
```
  - referencedByBiCollection
```
protected ItemList<BiCollection> referencedByBiCollection
```
  - referencedByBiHierarchies
```
protected ItemList<BiHierarchy> referencedByBiHierarchies
```
  - referencesBiCollections
```
protected ItemList<BiCollection> referencesBiCollections
```
  - type
```
protected String type
```
  - typeDefinition
```
protected String typeDefinition
```
  - usedByBiCubes
```
protected ItemList<BiCube> usedByBiCubes
```
  - usedByBiReportQueries
```
protected ItemList<BiReportQuery> usedByBiReportQueries
```
  - usesDatabaseTablesOrViews
```
protected ItemList<Datagroup> usesDatabaseTablesOrViews
```
- Constructor Detail
  - BiCollection
```
public BiCollection()
```
- Method Detail
  - getAliasBusinessName
```
public String getAliasBusinessName()
```
    Retrieve the alias_(business_name) property (displayed as 'Alias (Business Name)') of the object.
    
    Returns:
    
    String
  - setAliasBusinessName
```
public void setAliasBusinessName(String aliasBusinessName)
```
    Set the alias_(business_name) property (displayed as Alias (Business Name)) of the object.
    
    Parameters:
    
    aliasBusinessName - the value to set
  - getBiCollection
```
public BiCollection getBiCollection()
```
    Retrieve the bi_collection property (displayed as 'BI Collection') of the object.
    
    Returns:
    
    BiCollection
  - setBiCollection
```
public void setBiCollection(BiCollection biCollection)
```
    Set the bi_collection property (displayed as BI Collection) of the object.
    
    Parameters:
    
    biCollection - the value to set
  - getBiCollectionMembers
```
public ItemList<BiCollectionMember> getBiCollectionMembers()
```
    Retrieve the bi_collection_members property (displayed as 'BI Collection Members') of the object.
    
    Returns:
    
    ItemList<BiCollectionMember>
  - setBiCollectionMembers
```
public void setBiCollectionMembers(ItemList<BiCollectionMember> biCollectionMembers)
```
    Set the bi_collection_members property (displayed as BI Collection Members) of the object.
    
    Parameters:
    
    biCollectionMembers - the value to set
  - getBiFilters
```
public ItemList<BiFilter> getBiFilters()
```
    Retrieve the bi_filters property (displayed as 'BI Filters') of the object.
    
    Returns:
    
    ItemList<BiFilter>
  - setBiFilters
```
public void setBiFilters(ItemList<BiFilter> biFilters)
```
    Set the bi_filters property (displayed as BI Filters) of the object.
    
    Parameters:
    
    biFilters - the value to set
  - getBiHierarchies
```
public ItemList<BiHierarchy> getBiHierarchies()
```
    Retrieve the bi_hierarchies property (displayed as 'BI Hierarchies') of the object.
    
    Returns:
    
    ItemList<BiHierarchy>
  - setBiHierarchies
```
public void setBiHierarchies(ItemList<BiHierarchy> biHierarchies)
```
    Set the bi_hierarchies property (displayed as BI Hierarchies) of the object.
    
    Parameters:
    
    biHierarchies - the value to set
  - getBiLevels
```
public ItemList<BiLevel> getBiLevels()
```
    Retrieve the bi_levels property (displayed as 'BI Levels') of the object.
    
    Returns:
    
    ItemList<BiLevel>
  - setBiLevels
```
public void setBiLevels(ItemList<BiLevel> biLevels)
```
    Set the bi_levels property (displayed as BI Levels) of the object.
    
    Parameters:
    
    biLevels - the value to set
  - getBiModel
```
public BiModel getBiModel()
```
    Retrieve the bi_model property (displayed as 'BI Model') of the object.
    
    Returns:
    
    BiModel
  - setBiModel
```
public void setBiModel(BiModel biModel)
```
    Set the bi_model property (displayed as BI Model) of the object.
    
    Parameters:
    
    biModel - the value to set
  - getBiModelOrBiCollection
```
public ItemList<Olapobject> getBiModelOrBiCollection()
```
    Retrieve the bi_model_or_bi_collection property (displayed as 'BI Model or BI Collection') of the object.
    
    Returns:
    
    ItemList<Olapobject>
  - setBiModelOrBiCollection
```
public void setBiModelOrBiCollection(ItemList<Olapobject> biModelOrBiCollection)
```
    Set the bi_model_or_bi_collection property (displayed as BI Model or BI Collection) of the object.
    
    Parameters:
    
    biModelOrBiCollection - the value to set
  - getFilterExpression
```
public List<String> getFilterExpression()
```
    Retrieve the filter_expression property (displayed as 'Filter Expression') of the object.
    
    Returns:
    
    List<String>
  - setFilterExpression
```
public void setFilterExpression(List<String> filterExpression)
```
    Set the filter_expression property (displayed as Filter Expression) of the object.
    
    Parameters:
    
    filterExpression - the value to set
  - getHasOlapCollection
```
public ItemList<BiCollection> getHasOlapCollection()
```
    Retrieve the has_olap_collection property (displayed as 'Has OLAP Collection') of the object.
    
    Returns:
    
    ItemList<BiCollection>
  - setHasOlapCollection
```
public void setHasOlapCollection(ItemList<BiCollection> hasOlapCollection)
```
    Set the has_olap_collection property (displayed as Has OLAP Collection) of the object.
    
    Parameters:
    
    hasOlapCollection - the value to set
  - getImportedFrom
```
public String getImportedFrom()
```
    Retrieve the imported_from property (displayed as 'Imported From') of the object.
    
    Returns:
    
    String
  - setImportedFrom
```
public void setImportedFrom(String importedFrom)
```
    Set the imported_from property (displayed as Imported From) of the object.
    
    Parameters:
    
    importedFrom - the value to set
  - getJoinCondition
```
public List<String> getJoinCondition()
```
    Retrieve the join_condition property (displayed as 'Join Condition') of the object.
    
    Returns:
    
    List<String>
  - setJoinCondition
```
public void setJoinCondition(List<String> joinCondition)
```
    Set the join_condition property (displayed as Join Condition) of the object.
    
    Parameters:
    
    joinCondition - the value to set
  - getNamespace
```
public String getNamespace()
```
    Retrieve the namespace property (displayed as 'Namespace') of the object.
    
    Returns:
    
    String
  - setNamespace
```
public void setNamespace(String namespace)
```
    Set the namespace property (displayed as Namespace) of the object.
    
    Parameters:
    
    namespace - the value to set
  - getReferencedByBiCollection
```
public ItemList<BiCollection> getReferencedByBiCollection()
```
    Retrieve the referenced_by_bi_collection property (displayed as 'Referenced by BI Collection') of the object.
    
    Returns:
    
    ItemList<BiCollection>
  - setReferencedByBiCollection
```
public void setReferencedByBiCollection(ItemList<BiCollection> referencedByBiCollection)
```
    Set the referenced_by_bi_collection property (displayed as Referenced by BI Collection) of the object.
    
    Parameters:
    
    referencedByBiCollection - the value to set
  - getReferencedByBiHierarchies
```
public ItemList<BiHierarchy> getReferencedByBiHierarchies()
```
    Retrieve the referenced_by_bi_hierarchies property (displayed as 'Referenced by BI Hierarchies') of the object.
    
    Returns:
    
    ItemList<BiHierarchy>
  - setReferencedByBiHierarchies
```
public void setReferencedByBiHierarchies(ItemList<BiHierarchy> referencedByBiHierarchies)
```
    Set the referenced_by_bi_hierarchies property (displayed as Referenced by BI Hierarchies) of the object.
    
    Parameters:
    
    referencedByBiHierarchies - the value to set
  - getReferencesBiCollections
```
public ItemList<BiCollection> getReferencesBiCollections()
```
    Retrieve the references_bi_collections property (displayed as 'References BI Collections') of the object.
    
    Returns:
    
    ItemList<BiCollection>
  - setReferencesBiCollections
```
public void setReferencesBiCollections(ItemList<BiCollection> referencesBiCollections)
```
    Set the references_bi_collections property (displayed as References BI Collections) of the object.
    
    Parameters:
    
    referencesBiCollections - the value to set
  - getTheType
```
public String getTheType()
```
    Retrieve the type property (displayed as 'Type') of the object.
    
    Returns:
    
    String
  - setTheType
```
public void setTheType(String type)
```
    Set the type property (displayed as Type) of the object.
    
    Parameters:
    
    type - the value to set
  - getTypeDefinition
```
public String getTypeDefinition()
```
    Retrieve the type_definition property (displayed as 'Type Definition') of the object.
    
    Returns:
    
    String
  - setTypeDefinition
```
public void setTypeDefinition(String typeDefinition)
```
    Set the type_definition property (displayed as Type Definition) of the object.
    
    Parameters:
    
    typeDefinition - the value to set
  - getUsedByBiCubes
```
public ItemList<BiCube> getUsedByBiCubes()
```
    Retrieve the used_by_bi_cubes property (displayed as 'Used by BI Cubes') of the object.
    
    Returns:
    
    ItemList<BiCube>
  - setUsedByBiCubes
```
public void setUsedByBiCubes(ItemList<BiCube> usedByBiCubes)
```
    Set the used_by_bi_cubes property (displayed as Used by BI Cubes) of the object.
    
    Parameters:
    
    usedByBiCubes - the value to set
  - getUsedByBiReportQueries
```
public ItemList<BiReportQuery> getUsedByBiReportQueries()
```
    Retrieve the used_by_bi_report_queries property (displayed as 'Used by BI Report Queries') of the object.
    
    Returns:
    
    ItemList<BiReportQuery>
  - setUsedByBiReportQueries
```
public void setUsedByBiReportQueries(ItemList<BiReportQuery> usedByBiReportQueries)
```
    Set the used_by_bi_report_queries property (displayed as Used by BI Report Queries) of the object.
    
    Parameters:
    
    usedByBiReportQueries - the value to set
  - getUsesDatabaseTablesOrViews
```
public ItemList<Datagroup> getUsesDatabaseTablesOrViews()
```
    Retrieve the uses_database_tables_or_views property (displayed as 'Uses Database Tables or Views') of the object.
    
    Returns:
    
    ItemList<Datagroup>
  - setUsesDatabaseTablesOrViews
```
public void setUsesDatabaseTablesOrViews(ItemList<Datagroup> usesDatabaseTablesOrViews)
```
    Set the uses_database_tables_or_views property (displayed as Uses Database Tables or Views) of the object.
    
    Parameters:
    
    usesDatabaseTablesOrViews - the value to set

Class BiCollection

Field Summary

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

aliasBusinessName

biCollection

biCollectionMembers

biFilters

biHierarchies

biLevels

biModel

biModelOrBiCollection

filterExpression

hasOlapCollection

importedFrom

joinCondition

namespace

referencedByBiCollection

referencedByBiHierarchies

referencesBiCollections

type

typeDefinition

usedByBiCubes

usedByBiReportQueries

usesDatabaseTablesOrViews

Constructor Detail

BiCollection

Method Detail

getAliasBusinessName

setAliasBusinessName

getBiCollection

setBiCollection

getBiCollectionMembers

setBiCollectionMembers

getBiFilters

setBiFilters

getBiHierarchies

setBiHierarchies

getBiLevels

setBiLevels

getBiModel

setBiModel

getBiModelOrBiCollection

setBiModelOrBiCollection

getFilterExpression

setFilterExpression

getHasOlapCollection

setHasOlapCollection

getImportedFrom

setImportedFrom

getJoinCondition

setJoinCondition

getNamespace

setNamespace

getReferencedByBiCollection

setReferencedByBiCollection

getReferencedByBiHierarchies

setReferencedByBiHierarchies

getReferencesBiCollections

setReferencesBiCollections

getTheType

setTheType

getTypeDefinition

setTypeDefinition

getUsedByBiCubes

setUsedByBiCubes

getUsedByBiReportQueries

setUsedByBiReportQueries

getUsesDatabaseTablesOrViews

setUsesDatabaseTablesOrViews