File (IBM Information Governance Catalog REST API Client Library 1.0 API)

java.lang.Object
- org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
  - - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.generated.v11700.File

```
public class File
extends Reference
```
POJO for the file asset type in IGC, displayed as 'File' in the IGC UI.

(this code has been generated 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`	`alias__business_name_` The `alias_(business_name)` property, displayed as 'Alias (Business Name)' in the IGC UI.
`protected ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected String`	`created_by` The `created_by` property, displayed as 'Created By' in the IGC UI.
`protected Date`	`created_on` The `created_on` property, displayed as 'Created On' in the IGC UI.
`protected ReferenceList`	`governed_by_rules` The `governed_by_rules` property, displayed as 'Governed by Rules' in the IGC UI.
`protected ReferenceList`	`impacted_by` The `impacted_by` property, displayed as 'Impacted by' in the IGC UI.
`protected ReferenceList`	`impacts_on` The `impacts_on` property, displayed as 'Impacts on' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected ReferenceList`	`in_collections` The `in_collections` property, displayed as 'In Collections' in the IGC UI.
`protected Boolean`	`include_for_business_lineage` The `include_for_business_lineage` property, displayed as 'Include for Business Lineage' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected String`	`modified_by` The `modified_by` property, displayed as 'Modified By' in the IGC UI.
`protected Date`	`modified_on` The `modified_on` property, displayed as 'Modified On' in the IGC UI.
`protected String`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected ReferenceList`	`read_by__design_` The `read_by_(design)` property, displayed as 'Read by (Design)' in the IGC UI.
`protected ReferenceList`	`read_by__operational_` The `read_by_(operational)` property, displayed as 'Read by (Operational)' in the IGC UI.
`protected ReferenceList`	`read_by__static_` The `read_by_(static)` property, displayed as 'Read by (Static)' in the IGC UI.
`protected ReferenceList`	`read_by__user_defined_` The `read_by_(user_defined)` property, displayed as 'Read by (User-Defined)' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected ReferenceList`	`written_by__design_` The `written_by_(design)` property, displayed as 'Written by (Design)' in the IGC UI.
`protected ReferenceList`	`written_by__operational_` The `written_by_(operational)` property, displayed as 'Written by (Operational)' in the IGC UI.
`protected ReferenceList`	`written_by__static_` The `written_by_(static)` property, displayed as 'Written by (Static)' in the IGC UI.
`protected ReferenceList`	`written_by__user_defined_` The `written_by_(user_defined)` property, displayed as 'Written by (User-Defined)' in the IGC UI.

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url

Constructor Summary

Constructors
Constructor and Description

File()

Constructors
Constructor and Description
`File()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`String`	`getAliasBusinessName()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImpactedBy()`
`ReferenceList`	`getImpactsOn()`
`ReferenceList`	`getImplementsRules()`
`Boolean`	`getIncludeForBusinessLineage()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`ReferenceList`	`getReadByDesign()`
`ReferenceList`	`getReadByOperational()`
`ReferenceList`	`getReadByStatic()`
`ReferenceList`	`getReadByUserDefined()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`ReferenceList`	`getWrittenByDesign()`
`ReferenceList`	`getWrittenByOperational()`
`ReferenceList`	`getWrittenByStatic()`
`ReferenceList`	`getWrittenByUserDefined()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isFile(Object obj)`
`void`	`setAliasBusinessName(String alias__business_name_)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImpactedBy(ReferenceList impacted_by)`
`void`	`setImpactsOn(ReferenceList impacts_on)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setIncludeForBusinessLineage(Boolean include_for_business_lineage)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setReadByDesign(ReferenceList read_by__design_)`
`void`	`setReadByOperational(ReferenceList read_by__operational_)`
`void`	`setReadByStatic(ReferenceList read_by__static_)`
`void`	`setReadByUserDefined(ReferenceList read_by__user_defined_)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setWrittenByDesign(ReferenceList written_by__design_)`
`void`	`setWrittenByOperational(ReferenceList written_by__operational_)`
`void`	`setWrittenByStatic(ReferenceList written_by__static_)`
`void`	`setWrittenByUserDefined(ReferenceList written_by__user_defined_)`

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
canAssetBeCreatedFromPOJO, getAllPropertiesFromPOJO, getAssetDetails, getAssetTypeForSearch, getAssetTypeFromPOJO, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getContext, getDisplayNameFromPOJO, getFieldByName, getFullAssetDetails, getId, getIdentity, getName, getNonRelationshipPropertiesFromPOJO, getPagedRelationalPropertiesFromPOJO, getPropertyByName, getStringPropertiesFromPOJO, getType, getUrl, hasModificationDetails, hasModificationDetails, hasProperty, isCreatableFromPOJO, isFullyRetrieved, isReference, isReference, isReferenceList, isReferenceList, isSimpleType, isSimpleType, populateContext, populateModificationDetails, setContext, setFullyRetrieved, setId, setName, setPropertyByName, setType, setUrl

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
getAllFields, toString

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

- Field Detail
  - name
```
protected String name
```
    The name property, displayed as 'Name' in the IGC UI.
  - short_description
```
protected String short_description
```
    The short_description property, displayed as 'Short Description' in the IGC UI.
  - long_description
```
protected String long_description
```
    The long_description property, displayed as 'Long Description' in the IGC UI.
  - labels
```
protected ReferenceList labels
```
    The labels property, displayed as 'Labels' in the IGC UI.
    
    Will be a ReferenceList of Label objects.
  - stewards
```
protected ReferenceList stewards
```
    The stewards property, displayed as 'Stewards' in the IGC UI.
    
    Will be a ReferenceList of AsclSteward objects.
  - assigned_to_terms
```
protected ReferenceList assigned_to_terms
```
    The assigned_to_terms property, displayed as 'Assigned to Terms' in the IGC UI.
    
    Will be a ReferenceList of Term objects.
  - implements_rules
```
protected ReferenceList implements_rules
```
    The implements_rules property, displayed as 'Implements Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - governed_by_rules
```
protected ReferenceList governed_by_rules
```
    The governed_by_rules property, displayed as 'Governed by Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - alias__business_name_
```
protected String alias__business_name_
```
    The alias_(business_name) property, displayed as 'Alias (Business Name)' in the IGC UI.
  - read_by__static_
```
protected ReferenceList read_by__static_
```
    The read_by_(static) property, displayed as 'Read by (Static)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - written_by__static_
```
protected ReferenceList written_by__static_
```
    The written_by_(static) property, displayed as 'Written by (Static)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - read_by__design_
```
protected ReferenceList read_by__design_
```
    The read_by_(design) property, displayed as 'Read by (Design)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - written_by__design_
```
protected ReferenceList written_by__design_
```
    The written_by_(design) property, displayed as 'Written by (Design)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - read_by__operational_
```
protected ReferenceList read_by__operational_
```
    The read_by_(operational) property, displayed as 'Read by (Operational)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - written_by__operational_
```
protected ReferenceList written_by__operational_
```
    The written_by_(operational) property, displayed as 'Written by (Operational)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - read_by__user_defined_
```
protected ReferenceList read_by__user_defined_
```
    The read_by_(user_defined) property, displayed as 'Read by (User-Defined)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - written_by__user_defined_
```
protected ReferenceList written_by__user_defined_
```
    The written_by_(user_defined) property, displayed as 'Written by (User-Defined)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - impacted_by
```
protected ReferenceList impacted_by
```
    The impacted_by property, displayed as 'Impacted by' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - impacts_on
```
protected ReferenceList impacts_on
```
    The impacts_on property, displayed as 'Impacts on' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - include_for_business_lineage
```
protected Boolean include_for_business_lineage
```
    The include_for_business_lineage property, displayed as 'Include for Business Lineage' in the IGC UI.
  - in_collections
```
protected ReferenceList in_collections
```
    The in_collections property, displayed as 'In Collections' in the IGC UI.
    
    Will be a ReferenceList of Collection objects.
  - created_by
```
protected String created_by
```
    The created_by property, displayed as 'Created By' in the IGC UI.
  - created_on
```
protected Date created_on
```
    The created_on property, displayed as 'Created On' in the IGC UI.
  - modified_by
```
protected String modified_by
```
    The modified_by property, displayed as 'Modified By' in the IGC UI.
  - modified_on
```
protected Date modified_on
```
    The modified_on property, displayed as 'Modified On' in the IGC UI.
- Constructor Detail
  - File
```
public File()
```
- Method Detail
  - getIgcTypeId
```
public static String getIgcTypeId()
```
  - getIgcTypeDisplayName
```
public static String getIgcTypeDisplayName()
```
  - getTheName
```
public String getTheName()
```
    See Also:
    
    name
  - setTheName
```
public void setTheName(String name)
```
    See Also:
    
    name
  - getShortDescription
```
public String getShortDescription()
```
    See Also:
    
    short_description
  - setShortDescription
```
public void setShortDescription(String short_description)
```
    See Also:
    
    short_description
  - getLongDescription
```
public String getLongDescription()
```
    See Also:
    
    long_description
  - setLongDescription
```
public void setLongDescription(String long_description)
```
    See Also:
    
    long_description
  - getLabels
```
public ReferenceList getLabels()
```
    See Also:
    
    labels
  - setLabels
```
public void setLabels(ReferenceList labels)
```
    See Also:
    
    labels
  - getStewards
```
public ReferenceList getStewards()
```
    See Also:
    
    stewards
  - setStewards
```
public void setStewards(ReferenceList stewards)
```
    See Also:
    
    stewards
  - getAssignedToTerms
```
public ReferenceList getAssignedToTerms()
```
    See Also:
    
    assigned_to_terms
  - setAssignedToTerms
```
public void setAssignedToTerms(ReferenceList assigned_to_terms)
```
    See Also:
    
    assigned_to_terms
  - getImplementsRules
```
public ReferenceList getImplementsRules()
```
    See Also:
    
    implements_rules
  - setImplementsRules
```
public void setImplementsRules(ReferenceList implements_rules)
```
    See Also:
    
    implements_rules
  - getGovernedByRules
```
public ReferenceList getGovernedByRules()
```
    See Also:
    
    governed_by_rules
  - setGovernedByRules
```
public void setGovernedByRules(ReferenceList governed_by_rules)
```
    See Also:
    
    governed_by_rules
  - getAliasBusinessName
```
public String getAliasBusinessName()
```
    See Also:
    
    alias__business_name_
  - setAliasBusinessName
```
public void setAliasBusinessName(String alias__business_name_)
```
    See Also:
    
    alias__business_name_
  - getReadByStatic
```
public ReferenceList getReadByStatic()
```
    See Also:
    
    read_by__static_
  - setReadByStatic
```
public void setReadByStatic(ReferenceList read_by__static_)
```
    See Also:
    
    read_by__static_
  - getWrittenByStatic
```
public ReferenceList getWrittenByStatic()
```
    See Also:
    
    written_by__static_
  - setWrittenByStatic
```
public void setWrittenByStatic(ReferenceList written_by__static_)
```
    See Also:
    
    written_by__static_
  - getReadByDesign
```
public ReferenceList getReadByDesign()
```
    See Also:
    
    read_by__design_
  - setReadByDesign
```
public void setReadByDesign(ReferenceList read_by__design_)
```
    See Also:
    
    read_by__design_
  - getWrittenByDesign
```
public ReferenceList getWrittenByDesign()
```
    See Also:
    
    written_by__design_
  - setWrittenByDesign
```
public void setWrittenByDesign(ReferenceList written_by__design_)
```
    See Also:
    
    written_by__design_
  - getReadByOperational
```
public ReferenceList getReadByOperational()
```
    See Also:
    
    read_by__operational_
  - setReadByOperational
```
public void setReadByOperational(ReferenceList read_by__operational_)
```
    See Also:
    
    read_by__operational_
  - getWrittenByOperational
```
public ReferenceList getWrittenByOperational()
```
    See Also:
    
    written_by__operational_
  - setWrittenByOperational
```
public void setWrittenByOperational(ReferenceList written_by__operational_)
```
    See Also:
    
    written_by__operational_
  - getReadByUserDefined
```
public ReferenceList getReadByUserDefined()
```
    See Also:
    
    read_by__user_defined_
  - setReadByUserDefined
```
public void setReadByUserDefined(ReferenceList read_by__user_defined_)
```
    See Also:
    
    read_by__user_defined_
  - getWrittenByUserDefined
```
public ReferenceList getWrittenByUserDefined()
```
    See Also:
    
    written_by__user_defined_
  - setWrittenByUserDefined
```
public void setWrittenByUserDefined(ReferenceList written_by__user_defined_)
```
    See Also:
    
    written_by__user_defined_
  - getImpactedBy
```
public ReferenceList getImpactedBy()
```
    See Also:
    
    impacted_by
  - setImpactedBy
```
public void setImpactedBy(ReferenceList impacted_by)
```
    See Also:
    
    impacted_by
  - getImpactsOn
```
public ReferenceList getImpactsOn()
```
    See Also:
    
    impacts_on
  - setImpactsOn
```
public void setImpactsOn(ReferenceList impacts_on)
```
    See Also:
    
    impacts_on
  - getIncludeForBusinessLineage
```
public Boolean getIncludeForBusinessLineage()
```
    See Also:
    
    include_for_business_lineage
  - setIncludeForBusinessLineage
```
public void setIncludeForBusinessLineage(Boolean include_for_business_lineage)
```
    See Also:
    
    include_for_business_lineage
  - getInCollections
```
public ReferenceList getInCollections()
```
    See Also:
    
    in_collections
  - setInCollections
```
public void setInCollections(ReferenceList in_collections)
```
    See Also:
    
    in_collections
  - getCreatedBy
```
public String getCreatedBy()
```
    See Also:
    
    created_by
  - setCreatedBy
```
public void setCreatedBy(String created_by)
```
    See Also:
    
    created_by
  - getCreatedOn
```
public Date getCreatedOn()
```
    See Also:
    
    created_on
  - setCreatedOn
```
public void setCreatedOn(Date created_on)
```
    See Also:
    
    created_on
  - getModifiedBy
```
public String getModifiedBy()
```
    See Also:
    
    modified_by
  - setModifiedBy
```
public void setModifiedBy(String modified_by)
```
    See Also:
    
    modified_by
  - getModifiedOn
```
public Date getModifiedOn()
```
    See Also:
    
    modified_on
  - setModifiedOn
```
public void setModifiedOn(Date modified_on)
```
    See Also:
    
    modified_on
  - canBeCreated
```
public static Boolean canBeCreated()
```
  - includesModificationDetails
```
public static Boolean includesModificationDetails()
```
  - getNonRelationshipProperties
```
public static List<String> getNonRelationshipProperties()
```
  - getStringProperties
```
public static List<String> getStringProperties()
```
  - getPagedRelationshipProperties
```
public static List<String> getPagedRelationshipProperties()
```
  - getAllProperties
```
public static List<String> getAllProperties()
```
  - isFile
```
public static Boolean isFile(Object obj)
```

Class File

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

name

short_description

long_description

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

alias__business_name_

read_by__static_

written_by__static_

read_by__design_

written_by__design_

read_by__operational_

written_by__operational_

read_by__user_defined_

written_by__user_defined_

impacted_by

impacts_on

include_for_business_lineage

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

File

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getAliasBusinessName

setAliasBusinessName

getReadByStatic

setReadByStatic

getWrittenByStatic

setWrittenByStatic

getReadByDesign

setReadByDesign

getWrittenByDesign

setWrittenByDesign

getReadByOperational

setReadByOperational

getWrittenByOperational

setWrittenByOperational

getReadByUserDefined

setReadByUserDefined

getWrittenByUserDefined

setWrittenByUserDefined

getImpactedBy

setImpactedBy

getImpactsOn

setImpactsOn

getIncludeForBusinessLineage

setIncludeForBusinessLineage

getInCollections