Collection (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.v11701.Collection

```
public class Collection
extends Reference
```
POJO for the collection asset type in IGC, displayed as 'Collection' 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 ReferenceList`	`assets` The `assets` property, displayed as 'Assets' 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`	`in_collections` The `in_collections` property, displayed as 'In Collections' 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`	`owners` The `owners` property, displayed as 'Owners' in the IGC UI.
`protected ReferenceList`	`references_assets` The `references_assets` property, displayed as 'Assets' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected String`	`user_id` The `user_id` property, displayed as 'User Id' in the IGC UI.
`protected ReferenceList`	`viewers` The `viewers` property, displayed as 'Viewers' in the IGC UI.
`protected Boolean`	`visibility` The `visibility` property, displayed as 'Visibility' 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

Collection()

Constructors
Constructor and Description
`Collection()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssets()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`ReferenceList`	`getOwners()`
`static List<String>`	`getPagedRelationshipProperties()`
`ReferenceList`	`getReferencesAssets()`
`String`	`getShortDescription()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`String`	`getUserId()`
`ReferenceList`	`getViewers()`
`Boolean`	`getVisibility()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isCollection(Object obj)`
`void`	`setAssets(ReferenceList assets)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`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`	`setOwners(ReferenceList owners)`
`void`	`setReferencesAssets(ReferenceList references_assets)`
`void`	`setShortDescription(String short_description)`
`void`	`setTheName(String name)`
`void`	`setUserId(String user_id)`
`void`	`setViewers(ReferenceList viewers)`
`void`	`setVisibility(Boolean visibility)`

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.
  - owners
```
protected ReferenceList owners
```
    The owners property, displayed as 'Owners' in the IGC UI.
    
    Will be a ReferenceList of Steward objects.
  - visibility
```
protected Boolean visibility
```
    The visibility property, displayed as 'Visibility' in the IGC UI.
  - viewers
```
protected ReferenceList viewers
```
    The viewers property, displayed as 'Viewers' in the IGC UI.
    
    Will be a ReferenceList of Steward objects.
  - user_id
```
protected String user_id
```
    The user_id property, displayed as 'User Id' in the IGC UI.
  - assets
```
protected ReferenceList assets
```
    The assets property, displayed as 'Assets' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - references_assets
```
protected ReferenceList references_assets
```
    The references_assets property, displayed as 'Assets' in the IGC UI.
    
    Will be a ReferenceList of MainObject objects.
  - 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
  - Collection
```
public Collection()
```
- 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
  - getOwners
```
public ReferenceList getOwners()
```
    See Also:
    
    owners
  - setOwners
```
public void setOwners(ReferenceList owners)
```
    See Also:
    
    owners
  - getVisibility
```
public Boolean getVisibility()
```
    See Also:
    
    visibility
  - setVisibility
```
public void setVisibility(Boolean visibility)
```
    See Also:
    
    visibility
  - getViewers
```
public ReferenceList getViewers()
```
    See Also:
    
    viewers
  - setViewers
```
public void setViewers(ReferenceList viewers)
```
    See Also:
    
    viewers
  - getUserId
```
public String getUserId()
```
    See Also:
    
    user_id
  - setUserId
```
public void setUserId(String user_id)
```
    See Also:
    
    user_id
  - getAssets
```
public ReferenceList getAssets()
```
    See Also:
    
    assets
  - setAssets
```
public void setAssets(ReferenceList assets)
```
    See Also:
    
    assets
  - getReferencesAssets
```
public ReferenceList getReferencesAssets()
```
    See Also:
    
    references_assets
  - setReferencesAssets
```
public void setReferencesAssets(ReferenceList references_assets)
```
    See Also:
    
    references_assets
  - 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()
```
  - isCollection
```
public static Boolean isCollection(Object obj)
```

Class Collection

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

owners

visibility

viewers

user_id

assets

references_assets

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

Collection

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getOwners

setOwners

getVisibility

setVisibility

getViewers

setViewers

getUserId

setUserId

getAssets

setAssets

getReferencesAssets

setReferencesAssets

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isCollection