Package com.inductiveautomation.ignition.gateway.project.records

Class ProjectRecord

java.lang.Object

simpleorm.dataset.SRecordInstance

com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

com.inductiveautomation.ignition.gateway.project.records.ProjectRecord

All Implemented Interfaces:

Serializable

public class ProjectRecord
extends PersistentRecord

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class simpleorm.dataset.SRecordInstance

SRecordInstance.BrokenOptimisticLockException

Field Summary

Fields

Modifier and Type	Field	Description
static final BooleanField	Converted
static final StringField	Description
static final LongField	EditCount
static final BooleanField	Enabled
static final LongField	FirstRollbackEditPoint
static final IdentityField	Id
static final BooleanField	IsOEMLocked
static final DateField	LastModified
static final StringField	LastModifiedBy
static final RecordMeta<ProjectRecord>	META
static final StringField	Name
static final StringField	OEMLockId
static final String	PROJECT_NAME_PATTERN
static final LongField	PublishedEditCount
static final StringField	Source
static final StringField	Title
static final StringField	UUID

Fields inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

DEFAULT_VALUE, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor	Description
ProjectRecord()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getDisplayTitle()
long	getEditCount()
long	getFirstRollbackEditPoint()
long	getId()
Date	getLastModified()
String	getLastModifiedBy()
RecordMeta<ProjectRecord>	getMeta()	This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
String	getName()
String	getOemLockId()
String	getSource()
String	getTitle()
UUID	getUuid()
long	incrementEditCount()	Increments the current value of the EditCount field, setting the new value on this record and returning the new value
boolean	isConverted()
Boolean	isEnabled()
boolean	isOemLocked()
void	setAllProps(ResourceCollection project, GatewayContext context)	Sets properties from the given project object except for the id, editcount, and uuid
void	setConverted(boolean converted)
void	setSource(String source)
void	updateFirstRollbackEditPoint()

Methods inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

getBoolean, getDoubleObj, getIntObj, getLongObj, getString, installDefaultValues

Methods inherited from class simpleorm.dataset.SRecordInstance

allFields, assertNewRow, assertNotNewRow, defineInitialValue, deleteRecord, doQueryRecord, doValidateRecord, equals, findReference, findReference, findReference, findReference, getBigDecimal, getBytes, getDataSet, getDate, getDouble, getEnum, getInitialValue, getInt, getLogger, getLong, getObject, getRawArrayValue, getReferenceNoQuery, getTime, getTimestamp, hashCode, isAttached, isDeleted, isDirty, isDirty, isEmpty, isNewRow, isNotDestroyed, isNull, isReadOnly, isValid, onQueryRecord, onValidateField, onValidateRecord, setBigDecimal, setBoolean, setBytes, setDate, setDirty, setDouble, setEmpty, setEnum, setInt, setLong, setNewRow, setNull, setObject, setObject, setRawArrayValue, setReadOnly, setReference, setString, setTime, setTimestamp, toString, validatePrimaryKeys, wasInCache

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PROJECT_NAME_PATTERN

public static final String PROJECT_NAME_PATTERN

See Also:

• Constant Field Values

META

public static final RecordMeta<ProjectRecord> META

Id

public static final IdentityField Id

Name

public static final StringField Name

Description

public static final StringField Description

Title

public static final StringField Title

Source

public static final StringField Source

LastModified

public static final DateField LastModified

LastModifiedBy

public static final StringField LastModifiedBy

EditCount

public static final LongField EditCount

PublishedEditCount

public static final LongField PublishedEditCount

FirstRollbackEditPoint

public static final LongField FirstRollbackEditPoint

UUID

public static final StringField UUID

IsOEMLocked

public static final BooleanField IsOEMLocked

OEMLockId

public static final StringField OEMLockId

Enabled

public static final BooleanField Enabled

Converted

public static final BooleanField Converted

Constructor Details

ProjectRecord

public ProjectRecord()

Method Details

getMeta

public RecordMeta<ProjectRecord> getMeta()

Description copied from class: SRecordInstance

This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance. It is normally defined as:-

 SRecord getMeta() {
   return meta;
 };
 

The actual meta variable is thus not Serialized, but it would not be anyway as it is usually static.

Specified by:

getMeta in class PersistentRecord

getId

public long getId()

getName

public String getName()

getSource

public String getSource()

setSource

public void setSource(String source)

getTitle

public String getTitle()

getDisplayTitle

public String getDisplayTitle()

getDescription

public String getDescription()

isEnabled

public Boolean isEnabled()

getLastModified

public Date getLastModified()

getLastModifiedBy

public String getLastModifiedBy()

getEditCount

public long getEditCount()

getFirstRollbackEditPoint

public long getFirstRollbackEditPoint()

updateFirstRollbackEditPoint

public void updateFirstRollbackEditPoint()

getUuid

public UUID getUuid()

isOemLocked

public boolean isOemLocked()

getOemLockId

public String getOemLockId()

isConverted

public boolean isConverted()

setConverted

public void setConverted(boolean converted)

incrementEditCount

public long incrementEditCount()

Increments the current value of the EditCount field, setting the new value on this record and returning the new value

setAllProps

public void setAllProps(ResourceCollection project,
 GatewayContext context)

Sets properties from the given project object except for the id, editcount, and uuid