DesignStoredProcedure (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.DesignStoredProcedure

```
public class DesignStoredProcedure
extends Reference
```
POJO for the design_stored_procedure asset type in IGC, displayed as 'Design Stored Procedure' 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`	`design_stored_procedure_parameters` The `design_stored_procedure_parameters` property, displayed as 'Design Stored Procedure Parameters' in the IGC UI.
`protected String`	`error_code` The `error_code` property, displayed as 'Error Code' 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`	`implemented_by_stored_procedures` The `implemented_by_stored_procedures` property, displayed as 'Implemented by Stored Procedures' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected String`	`imported_from` The `imported_from` property, displayed as 'Imported From' 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 String`	`name_qualifier` The `name_qualifier` property, displayed as 'Name Qualifier' in the IGC UI.
`protected Reference`	`physical_data_model` The `physical_data_model` property, displayed as 'Physical Data Model' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected String`	`source_code` The `source_code` property, displayed as 'Source Code' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' 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

DesignStoredProcedure()

Constructors
Constructor and Description
`DesignStoredProcedure()`

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`	`getDesignStoredProcedureParameters()`
`String`	`getErrorCode()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementedByStoredProcedures()`
`ReferenceList`	`getImplementsRules()`
`String`	`getImportedFrom()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`String`	`getNameQualifier()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`Reference`	`getPhysicalDataModel()`
`String`	`getShortDescription()`
`String`	`getSourceCode()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isDesignStoredProcedure(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`	`setDesignStoredProcedureParameters(ReferenceList design_stored_procedure_parameters)`
`void`	`setErrorCode(String error_code)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementedByStoredProcedures(ReferenceList implemented_by_stored_procedures)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setImportedFrom(String imported_from)`
`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`	`setNameQualifier(String name_qualifier)`
`void`	`setPhysicalDataModel(Reference physical_data_model)`
`void`	`setShortDescription(String short_description)`
`void`	`setSourceCode(String source_code)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`

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.
  - physical_data_model
```
protected Reference physical_data_model
```
    The physical_data_model property, displayed as 'Physical Data Model' in the IGC UI.
    
    Will be a single Reference to a PhysicalDataModel object.
  - 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.
  - implemented_by_stored_procedures
```
protected ReferenceList implemented_by_stored_procedures
```
    The implemented_by_stored_procedures property, displayed as 'Implemented by Stored Procedures' in the IGC UI.
    
    Will be a ReferenceList of StoredProcedure objects.
  - design_stored_procedure_parameters
```
protected ReferenceList design_stored_procedure_parameters
```
    The design_stored_procedure_parameters property, displayed as 'Design Stored Procedure Parameters' in the IGC UI.
    
    Will be a ReferenceList of DesignStoredProcedureParameter objects.
  - alias__business_name_
```
protected String alias__business_name_
```
    The alias_(business_name) property, displayed as 'Alias (Business Name)' in the IGC UI.
  - name_qualifier
```
protected String name_qualifier
```
    The name_qualifier property, displayed as 'Name Qualifier' in the IGC UI.
  - source_code
```
protected String source_code
```
    The source_code property, displayed as 'Source Code' in the IGC UI.
  - error_code
```
protected String error_code
```
    The error_code property, displayed as 'Error Code' in the IGC UI.
  - imported_from
```
protected String imported_from
```
    The imported_from property, displayed as 'Imported From' 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
  - DesignStoredProcedure
```
public DesignStoredProcedure()
```
- 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
  - getPhysicalDataModel
```
public Reference getPhysicalDataModel()
```
    See Also:
    
    physical_data_model
  - setPhysicalDataModel
```
public void setPhysicalDataModel(Reference physical_data_model)
```
    See Also:
    
    physical_data_model
  - 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
  - getImplementedByStoredProcedures
```
public ReferenceList getImplementedByStoredProcedures()
```
    See Also:
    
    implemented_by_stored_procedures
  - setImplementedByStoredProcedures
```
public void setImplementedByStoredProcedures(ReferenceList implemented_by_stored_procedures)
```
    See Also:
    
    implemented_by_stored_procedures
  - getDesignStoredProcedureParameters
```
public ReferenceList getDesignStoredProcedureParameters()
```
    See Also:
    
    design_stored_procedure_parameters
  - setDesignStoredProcedureParameters
```
public void setDesignStoredProcedureParameters(ReferenceList design_stored_procedure_parameters)
```
    See Also:
    
    design_stored_procedure_parameters
  - getAliasBusinessName
```
public String getAliasBusinessName()
```
    See Also:
    
    alias__business_name_
  - setAliasBusinessName
```
public void setAliasBusinessName(String alias__business_name_)
```
    See Also:
    
    alias__business_name_
  - getNameQualifier
```
public String getNameQualifier()
```
    See Also:
    
    name_qualifier
  - setNameQualifier
```
public void setNameQualifier(String name_qualifier)
```
    See Also:
    
    name_qualifier
  - getSourceCode
```
public String getSourceCode()
```
    See Also:
    
    source_code
  - setSourceCode
```
public void setSourceCode(String source_code)
```
    See Also:
    
    source_code
  - getErrorCode
```
public String getErrorCode()
```
    See Also:
    
    error_code
  - setErrorCode
```
public void setErrorCode(String error_code)
```
    See Also:
    
    error_code
  - getImportedFrom
```
public String getImportedFrom()
```
    See Also:
    
    imported_from
  - setImportedFrom
```
public void setImportedFrom(String imported_from)
```
    See Also:
    
    imported_from
  - 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()
```
  - isDesignStoredProcedure
```
public static Boolean isDesignStoredProcedure(Object obj)
```

Class DesignStoredProcedure

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

physical_data_model

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

implemented_by_stored_procedures

design_stored_procedure_parameters

alias__business_name_

name_qualifier

source_code

error_code

imported_from

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

DesignStoredProcedure

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getPhysicalDataModel

setPhysicalDataModel

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getImplementedByStoredProcedures

setImplementedByStoredProcedures

getDesignStoredProcedureParameters

setDesignStoredProcedureParameters

getAliasBusinessName

setAliasBusinessName

getNameQualifier

setNameQualifier

getSourceCode

setSourceCode

getErrorCode

setErrorCode

getImportedFrom

setImportedFrom

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties