DsdesignView (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.v11501.DsdesignView

```
public class DsdesignView
extends Reference
```
POJO for the dsdesign_view asset type in IGC, displayed as 'Design View' 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`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected String`	`container_view_sizing` The `container_view_sizing` property, displayed as 'Container View Sizing' in the IGC UI.
`protected ReferenceList`	`governed_by_rules` The `governed_by_rules` property, displayed as 'Governed by Rules' in the IGC UI.
`protected Number`	`grid_lines` The `grid_lines` property, displayed as 'Grid Lines' in the IGC UI.
`protected ReferenceList`	`has_canvas_annotation` The `has_canvas_annotation` property, displayed as 'Has Canvas Annotation' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected String`	`input_pins` The `input_pins` property, displayed as 'Input Pins' in the IGC UI.
`protected String`	`internal_id` The `internal_id` property, displayed as 'Internal ID' in the IGC UI.
`protected Boolean`	`is_top_level` The `is_top_level` property, displayed as 'Is Top Level' 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`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected Number`	`next_id` The `next_id` property, displayed as 'Next ID' in the IGC UI.
`protected Number`	`next_stage_id` The `next_stage_id` property, displayed as 'Next Stage ID' in the IGC UI.
`protected Reference`	`of_job` The `of_job` property, displayed as 'Of Job' in the IGC UI.
`protected String`	`output_pins` The `output_pins` property, displayed as 'Output Pins' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected Number`	`snap_to_grid` The `snap_to_grid` property, displayed as 'Snap To Grid' in the IGC UI.
`protected String`	`stage_list` The `stage_list` property, displayed as 'Stage List' in the IGC UI.
`protected String`	`stage_types` The `stage_types` property, displayed as 'Stage Types' in the IGC UI.
`protected String`	`stage_x_pos` The `stage_x_pos` property, displayed as 'Stage X Pos' in the IGC UI.
`protected String`	`stage_x_size` The `stage_x_size` property, displayed as 'Stage X Size' in the IGC UI.
`protected String`	`stage_y_pos` The `stage_y_pos` property, displayed as 'Stage Y Pos' in the IGC UI.
`protected String`	`stage_y_size` The `stage_y_size` property, displayed as 'Stage Y Size' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected Number`	`zoom_value` The `zoom_value` property, displayed as 'Zoom Value' 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

DsdesignView()

Constructors
Constructor and Description
`DsdesignView()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getContainerViewSizing()`
`ReferenceList`	`getGovernedByRules()`
`Number`	`getGridLines()`
`ReferenceList`	`getHasCanvasAnnotation()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`String`	`getInputPins()`
`String`	`getInternalId()`
`Boolean`	`getIsTopLevel()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`Number`	`getNextId()`
`Number`	`getNextStageId()`
`static List<String>`	`getNonRelationshipProperties()`
`Reference`	`getOfJob()`
`String`	`getOutputPins()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getShortDescription()`
`Number`	`getSnapToGrid()`
`String`	`getStageList()`
`String`	`getStageTypes()`
`String`	`getStageXPos()`
`String`	`getStageXSize()`
`String`	`getStageYPos()`
`String`	`getStageYSize()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`Number`	`getZoomValue()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isDsdesignView(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setContainerViewSizing(String container_view_sizing)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setGridLines(Number grid_lines)`
`void`	`setHasCanvasAnnotation(ReferenceList has_canvas_annotation)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInputPins(String input_pins)`
`void`	`setInternalId(String internal_id)`
`void`	`setIsTopLevel(Boolean is_top_level)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLongDescription(String long_description)`
`void`	`setNextId(Number next_id)`
`void`	`setNextStageId(Number next_stage_id)`
`void`	`setOfJob(Reference of_job)`
`void`	`setOutputPins(String output_pins)`
`void`	`setShortDescription(String short_description)`
`void`	`setSnapToGrid(Number snap_to_grid)`
`void`	`setStageList(String stage_list)`
`void`	`setStageTypes(String stage_types)`
`void`	`setStageXPos(String stage_x_pos)`
`void`	`setStageXSize(String stage_x_size)`
`void`	`setStageYPos(String stage_y_pos)`
`void`	`setStageYSize(String stage_y_size)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setZoomValue(Number zoom_value)`

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.
  - has_canvas_annotation
```
protected ReferenceList has_canvas_annotation
```
    The has_canvas_annotation property, displayed as 'Has Canvas Annotation' in the IGC UI.
    
    Will be a ReferenceList of MainObject objects.
  - output_pins
```
protected String output_pins
```
    The output_pins property, displayed as 'Output Pins' in the IGC UI.
  - input_pins
```
protected String input_pins
```
    The input_pins property, displayed as 'Input Pins' in the IGC UI.
  - stage_types
```
protected String stage_types
```
    The stage_types property, displayed as 'Stage Types' in the IGC UI.
  - of_job
```
protected Reference of_job
```
    The of_job property, displayed as 'Of Job' in the IGC UI.
    
    Will be a single Reference to a Dsjob object.
  - next_id
```
protected Number next_id
```
    The next_id property, displayed as 'Next ID' in the IGC UI.
  - next_stage_id
```
protected Number next_stage_id
```
    The next_stage_id property, displayed as 'Next Stage ID' in the IGC UI.
  - is_top_level
```
protected Boolean is_top_level
```
    The is_top_level property, displayed as 'Is Top Level' in the IGC UI.
  - snap_to_grid
```
protected Number snap_to_grid
```
    The snap_to_grid property, displayed as 'Snap To Grid' in the IGC UI.
  - stage_x_pos
```
protected String stage_x_pos
```
    The stage_x_pos property, displayed as 'Stage X Pos' in the IGC UI.
  - grid_lines
```
protected Number grid_lines
```
    The grid_lines property, displayed as 'Grid Lines' in the IGC UI.
  - zoom_value
```
protected Number zoom_value
```
    The zoom_value property, displayed as 'Zoom Value' in the IGC UI.
  - container_view_sizing
```
protected String container_view_sizing
```
    The container_view_sizing property, displayed as 'Container View Sizing' in the IGC UI.
  - stage_list
```
protected String stage_list
```
    The stage_list property, displayed as 'Stage List' in the IGC UI.
  - stage_y_pos
```
protected String stage_y_pos
```
    The stage_y_pos property, displayed as 'Stage Y Pos' in the IGC UI.
  - stage_y_size
```
protected String stage_y_size
```
    The stage_y_size property, displayed as 'Stage Y Size' in the IGC UI.
  - stage_x_size
```
protected String stage_x_size
```
    The stage_x_size property, displayed as 'Stage X Size' in the IGC UI.
  - internal_id
```
protected String internal_id
```
    The internal_id property, displayed as 'Internal ID' in the IGC UI.
- Constructor Detail
  - DsdesignView
```
public DsdesignView()
```
- 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
  - getHasCanvasAnnotation
```
public ReferenceList getHasCanvasAnnotation()
```
    See Also:
    
    has_canvas_annotation
  - setHasCanvasAnnotation
```
public void setHasCanvasAnnotation(ReferenceList has_canvas_annotation)
```
    See Also:
    
    has_canvas_annotation
  - getOutputPins
```
public String getOutputPins()
```
    See Also:
    
    output_pins
  - setOutputPins
```
public void setOutputPins(String output_pins)
```
    See Also:
    
    output_pins
  - getInputPins
```
public String getInputPins()
```
    See Also:
    
    input_pins
  - setInputPins
```
public void setInputPins(String input_pins)
```
    See Also:
    
    input_pins
  - getStageTypes
```
public String getStageTypes()
```
    See Also:
    
    stage_types
  - setStageTypes
```
public void setStageTypes(String stage_types)
```
    See Also:
    
    stage_types
  - getOfJob
```
public Reference getOfJob()
```
    See Also:
    
    of_job
  - setOfJob
```
public void setOfJob(Reference of_job)
```
    See Also:
    
    of_job
  - getNextId
```
public Number getNextId()
```
    See Also:
    
    next_id
  - setNextId
```
public void setNextId(Number next_id)
```
    See Also:
    
    next_id
  - getNextStageId
```
public Number getNextStageId()
```
    See Also:
    
    next_stage_id
  - setNextStageId
```
public void setNextStageId(Number next_stage_id)
```
    See Also:
    
    next_stage_id
  - getIsTopLevel
```
public Boolean getIsTopLevel()
```
    See Also:
    
    is_top_level
  - setIsTopLevel
```
public void setIsTopLevel(Boolean is_top_level)
```
    See Also:
    
    is_top_level
  - getSnapToGrid
```
public Number getSnapToGrid()
```
    See Also:
    
    snap_to_grid
  - setSnapToGrid
```
public void setSnapToGrid(Number snap_to_grid)
```
    See Also:
    
    snap_to_grid
  - getStageXPos
```
public String getStageXPos()
```
    See Also:
    
    stage_x_pos
  - setStageXPos
```
public void setStageXPos(String stage_x_pos)
```
    See Also:
    
    stage_x_pos
  - getGridLines
```
public Number getGridLines()
```
    See Also:
    
    grid_lines
  - setGridLines
```
public void setGridLines(Number grid_lines)
```
    See Also:
    
    grid_lines
  - getZoomValue
```
public Number getZoomValue()
```
    See Also:
    
    zoom_value
  - setZoomValue
```
public void setZoomValue(Number zoom_value)
```
    See Also:
    
    zoom_value
  - getContainerViewSizing
```
public String getContainerViewSizing()
```
    See Also:
    
    container_view_sizing
  - setContainerViewSizing
```
public void setContainerViewSizing(String container_view_sizing)
```
    See Also:
    
    container_view_sizing
  - getStageList
```
public String getStageList()
```
    See Also:
    
    stage_list
  - setStageList
```
public void setStageList(String stage_list)
```
    See Also:
    
    stage_list
  - getStageYPos
```
public String getStageYPos()
```
    See Also:
    
    stage_y_pos
  - setStageYPos
```
public void setStageYPos(String stage_y_pos)
```
    See Also:
    
    stage_y_pos
  - getStageYSize
```
public String getStageYSize()
```
    See Also:
    
    stage_y_size
  - setStageYSize
```
public void setStageYSize(String stage_y_size)
```
    See Also:
    
    stage_y_size
  - getStageXSize
```
public String getStageXSize()
```
    See Also:
    
    stage_x_size
  - setStageXSize
```
public void setStageXSize(String stage_x_size)
```
    See Also:
    
    stage_x_size
  - getInternalId
```
public String getInternalId()
```
    See Also:
    
    internal_id
  - setInternalId
```
public void setInternalId(String internal_id)
```
    See Also:
    
    internal_id
  - 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()
```
  - isDsdesignView
```
public static Boolean isDsdesignView(Object obj)
```

Class DsdesignView

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

has_canvas_annotation

output_pins

input_pins

stage_types

of_job

next_id

next_stage_id

is_top_level

snap_to_grid

stage_x_pos

grid_lines

zoom_value

container_view_sizing

stage_list

stage_y_pos

stage_y_size

stage_x_size

internal_id

Constructor Detail

DsdesignView

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getHasCanvasAnnotation

setHasCanvasAnnotation

getOutputPins

setOutputPins

getInputPins

setInputPins

getStageTypes

setStageTypes

getOfJob

setOfJob

getNextId

setNextId

getNextStageId

setNextStageId

getIsTopLevel

setIsTopLevel

getSnapToGrid

setSnapToGrid

getStageXPos

setStageXPos

getGridLines

setGridLines

getZoomValue

setZoomValue