InstanceAuditHeader (Repository Services Connector APIs 0.1 API)

java.lang.Object
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceElementHeader
- - org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Classification, InstanceHeader
```
public abstract class InstanceAuditHeader
extends InstanceElementHeader
```
InstanceAuditHeader manages the attributes that are common to classifications and "proper" instances, ie as entities and relationships. We need to be able to audit when these fundamental elements change and by whom. Thus they share this header. The fields in this header are managed as follows:
- Type defines which TypeDef defines the type of concept/thing that this instance represents and controls the properties that can be stored in the instance.
- CreatedBy contains the userId of the person/engine that created the instance. This field is set up when the instance is created and not changed. It typically indicates who is the owner of the element and hence who has update rights.
- UpdatedBy contains the userId of the person/engine that last updated the instance. This field is set automatically by the open metadata repository when the update happens.
- CreateTime contains the Date/Time when the instance was created. It is set automatically by the open metadata repository when the instance is created.
- UpdateTime contains the Data/Time when the instance was last updated. It is also set automatically by the open metadata repository when the update happens.
- Version is a numeric count of the updates to the instance. It is used by the open metadata repositories to ensure updates to reference copies of the instance are applied in the right sequence. The home open metadata repository (where the create an all subsequent updates happen) maintains the version number.
- CurrentStatus indicates the status of the instance. It is initialized by the open metadata repository to the first status defined in the TypeDef. After that, it is the actions of the consumers of the metadata (typically the Open Metadata Access Services (OMASs)
- StatusOnDelete is populated when the instance is deleted and is se to the status when the deleted was called - it is used set the status if the instance is restored.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`createdBy`
`protected Date`	`createTime`
`protected InstanceStatus`	`currentStatus`
`protected InstanceStatus`	`statusOnDelete`
`protected InstanceType`	`type`
`protected String`	`updatedBy`
`protected Date`	`updateTime`
`protected long`	`version`

Constructor Summary

Constructors
Constructor and Description
`InstanceAuditHeader()` Default Constructor sets the instance to nulls.
`InstanceAuditHeader(InstanceAuditHeader template)` Copy/clone constructor set the value to those supplied in the template.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Validate if the supplied object equals this object.
`String`	`getCreatedBy()` Return the name of the user that created this instance.
`Date`	`getCreateTime()` Return the date/time that this instance was created.
`InstanceStatus`	`getStatus()` Return the status of this instance (UNKNOWN, PROPOSED, DRAFT, ACTIVE, DELETED).
`InstanceStatus`	`getStatusOnDelete()` Return the status to use when a deleted instance is restored.
`InstanceType`	`getType()` Return the type of this instance.
`String`	`getUpdatedBy()` Return the name of the user that last updated this instance.
`Date`	`getUpdateTime()` Return what was the late time this instance was updated.
`long`	`getVersion()` Return the version number for this instance.
`int`	`hashCode()` Return a hash code based on the values of this object.
`void`	`setCreatedBy(String createdBy)` Set up the name of the user that created this instance.
`void`	`setCreateTime(Date createTime)` Set up the time that this instance was created.
`void`	`setStatus(InstanceStatus newStatus)` Set up the status of this instance (UNKNOWN, PROPOSED, DRAFT, ACTIVE, DELETED).
`void`	`setStatusOnDelete(InstanceStatus statusOnDelete)` Set up the status to use when a deleted instance is restored.
`void`	`setType(InstanceType type)` Set up the type of this instance.
`void`	`setUpdatedBy(String updatedBy)` Set up the name of the user that last updated this instance.
`void`	`setUpdateTime(Date updateTime)` Set up the last update time for this instance.
`void`	`setVersion(long version)` Set up the version number for this instance.
`String`	`toString()` Standard toString method.

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

- Field Detail
  - type
```
protected InstanceType type
```
  - createdBy
```
protected String createdBy
```
  - updatedBy
```
protected String updatedBy
```
  - createTime
```
protected Date createTime
```
  - updateTime
```
protected Date updateTime
```
  - version
```
protected long version
```
  - currentStatus
```
protected InstanceStatus currentStatus
```
  - statusOnDelete
```
protected InstanceStatus statusOnDelete
```
- Constructor Detail
  - InstanceAuditHeader
```
public InstanceAuditHeader()
```
    Default Constructor sets the instance to nulls.
  - InstanceAuditHeader
```
public InstanceAuditHeader(InstanceAuditHeader template)
```
    Copy/clone constructor set the value to those supplied in the template.
    
    Parameters:
    
    template - Instance header
- Method Detail
  - getType
```
public InstanceType getType()
```
    Return the type of this instance. This identifies the type definition (TypeDef) that determines its properties.
    
    Returns:
    
    InstanceType object
  - setType
```
public void setType(InstanceType type)
```
    Set up the type of this instance. This identifies the type definition (TypeDef) that determines its properties.
    
    Parameters:
    
    type - InstanceType object
  - getStatus
```
public InstanceStatus getStatus()
```
    Return the status of this instance (UNKNOWN, PROPOSED, DRAFT, ACTIVE, DELETED).
    
    Returns:
    
    InstanceStatus
  - setStatus
```
public void setStatus(InstanceStatus newStatus)
```
    Set up the status of this instance (UNKNOWN, PROPOSED, DRAFT, ACTIVE, DELETED).
    
    Parameters:
    
    newStatus - InstanceStatus
  - getCreatedBy
```
public String getCreatedBy()
```
    Return the name of the user that created this instance.
    
    Returns:
    
    String user name
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    Set up the name of the user that created this instance.
    
    Parameters:
    
    createdBy - String user name
  - getUpdatedBy
```
public String getUpdatedBy()
```
    Return the name of the user that last updated this instance.
    
    Returns:
    
    String user name
  - setUpdatedBy
```
public void setUpdatedBy(String updatedBy)
```
    Set up the name of the user that last updated this instance.
    
    Parameters:
    
    updatedBy - String user name
  - getCreateTime
```
public Date getCreateTime()
```
    Return the date/time that this instance was created.
    
    Returns:
    
    Date/Time of creation
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    Set up the time that this instance was created.
    
    Parameters:
    
    createTime - Date/Time of creation
  - getUpdateTime
```
public Date getUpdateTime()
```
    Return what was the late time this instance was updated.
    
    Returns:
    
    Date/Time last updated
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    Set up the last update time for this instance.
    
    Parameters:
    
    updateTime - Date/Time last updated
  - getVersion
```
public long getVersion()
```
    Return the version number for this instance.
    
    Returns:
    
    Long version number
  - setVersion
```
public void setVersion(long version)
```
    Set up the version number for this instance.
    
    Parameters:
    
    version - Long version number
  - getStatusOnDelete
```
public InstanceStatus getStatusOnDelete()
```
    Return the status to use when a deleted instance is restored. UNKNOWN is used whenever the instance is not in DELETED status.
    
    Returns:
    
    InstanceStatus
  - setStatusOnDelete
```
public void setStatusOnDelete(InstanceStatus statusOnDelete)
```
    Set up the status to use when a deleted instance is restored. UNKNOWN is used whenever the instance is not in DELETED status.
    
    Parameters:
    
    statusOnDelete - InstanceStatus Enum
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    JSON style description of variables.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Validate if the supplied object equals this object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - test object
    
    Returns:
    
    boolean evaluation
  - hashCode
```
public int hashCode()
```
    Return a hash code based on the values of this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    in hash code

Class InstanceAuditHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

createdBy

updatedBy

createTime

updateTime

version

currentStatus

statusOnDelete

Constructor Detail

InstanceAuditHeader

InstanceAuditHeader

Method Detail

getType

setType

getStatus

setStatus

getCreatedBy

setCreatedBy

getUpdatedBy

setUpdatedBy

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getVersion

setVersion

getStatusOnDelete

setStatusOnDelete

toString

equals

hashCode