org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class AttributeTypeField

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.AttributeTypeField

public class AttributeTypeField
extends InformationAsset

POJO for the attribute_type_field asset type in IGC, displayed as 'Attribute Type Field' 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 AttributeType	attributeType
protected AttributeType	attributeTypeForQuery
protected Number	length
protected Boolean	required
protected String	type Valid values are: CHAR (displayed in the UI as 'CHAR') DATETIME (displayed in the UI as 'DATETIME') SQWORD (displayed in the UI as 'SQWORD') UDWORD (displayed in the UI as 'UDWORD') UWORD (displayed in the UI as 'UWORD') VARCHAR (displayed in the UI as 'VARCHAR')

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
AttributeTypeField()

Method Summary

Modifier and Type	Method and Description
String	getAliasBusinessName() Retrieve the alias_(business_name) property (displayed as 'Alias (Business Name)') of the object.
AttributeType	getAttributeType() Retrieve the attribute_type property (displayed as 'Attribute Type') of the object.
AttributeType	getAttributeTypeForQuery() Retrieve the attribute_type_for_query property (displayed as 'Attribute Type') of the object.
Number	getLength() Retrieve the length property (displayed as 'Length') of the object.
Boolean	getRequired() Retrieve the required property (displayed as 'Required') of the object.
String	getTheType() Retrieve the type property (displayed as 'Type') of the object.
void	setAliasBusinessName(String aliasBusinessName) Set the alias_(business_name) property (displayed as Alias (Business Name)) of the object.
void	setAttributeType(AttributeType attributeType) Set the attribute_type property (displayed as Attribute Type) of the object.
void	setAttributeTypeForQuery(AttributeType attributeTypeForQuery) Set the attribute_type_for_query property (displayed as Attribute Type) of the object.
void	setLength(Number length) Set the length property (displayed as Length) of the object.
void	setRequired(Boolean required) Set the required property (displayed as Required) of the object.
void	setTheType(String type) Set the type property (displayed as Type) 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

attributeType

protected AttributeType attributeType

attributeTypeForQuery

protected AttributeType attributeTypeForQuery

length

protected Number length

required

protected Boolean required

type

protected String type

Valid values are:

• CHAR (displayed in the UI as 'CHAR')
• DATETIME (displayed in the UI as 'DATETIME')
• SQWORD (displayed in the UI as 'SQWORD')
• UDWORD (displayed in the UI as 'UDWORD')
• UWORD (displayed in the UI as 'UWORD')
• VARCHAR (displayed in the UI as 'VARCHAR')

Constructor Detail

AttributeTypeField

public AttributeTypeField()

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

getAttributeType

public AttributeType getAttributeType()

Retrieve the attribute_type property (displayed as 'Attribute Type') of the object.

Returns:

AttributeType

setAttributeType

public void setAttributeType(AttributeType attributeType)

Set the attribute_type property (displayed as Attribute Type) of the object.

Parameters:

attributeType - the value to set

getAttributeTypeForQuery

public AttributeType getAttributeTypeForQuery()

Retrieve the attribute_type_for_query property (displayed as 'Attribute Type') of the object.

Returns:

AttributeType

setAttributeTypeForQuery

public void setAttributeTypeForQuery(AttributeType attributeTypeForQuery)

Set the attribute_type_for_query property (displayed as Attribute Type) of the object.

Parameters:

attributeTypeForQuery - the value to set

getLength

public Number getLength()

Retrieve the length property (displayed as 'Length') of the object.

Returns:

Number

setLength

public void setLength(Number length)

Set the length property (displayed as Length) of the object.

Parameters:

length - the value to set

getRequired

public Boolean getRequired()

Retrieve the required property (displayed as 'Required') of the object.

Returns:

Boolean

setRequired

public void setRequired(Boolean required)

Set the required property (displayed as Required) of the object.

Parameters:

required - 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