Package com.znize.platform.entity.system

Interface Instance

All Superinterfaces:

java.lang.Cloneable, CreatedDateAware, CreatorAware, NormativeId, PersistenceEntity

public interface Instance
extends PersistenceEntity, NormativeId, CreatorAware, CreatedDateAware

Instance. An instance consists of a tree of module nodes and maps to a persistence unit. It can be a system or subsystem instance. There can be many subsystem instances, but there is one and only one system instance.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Instance.AccessCtrl	Instance access control

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_ACCESS_CTRL	Property name: accessCtrl
static java.lang.String	PROPERTY_BOUND_DOMAINS	Property name: boundDomains
static java.lang.String	PROPERTY_INSTANCE_TYPE_ID	Property name: type
static java.lang.String	PROPERTY_NAME	Property name: name

Fields inherited from interface com.znize.platform.entity.CreatedDateAware

PROPERTY_CREATED_DATE

Fields inherited from interface com.znize.platform.entity.CreatorAware

PROPERTY_CREATOR

Fields inherited from interface com.znize.platform.entity.NormativeId

PROPERTY_BARCODE, PROPERTY_NID

Fields inherited from interface com.znize.platform.entity.PersistenceEntity

ID_SEPARATOR, PROPERTY_ID, PROPERTY_INSTANCE, PROPERTY_SELECTED, PROPERTY_SEQUENCE_NO, PROPERTY_VERSION

Method Summary

Modifier and Type	Method	Description
void	addBoundDomain(BoundDomain boundDomain)	Add the bound domain.
Instance.AccessCtrl	getAccessCtrl()	Get subsystem access control that can be read only, locked, or read-write.
java.util.List<BoundDomain>	getBoundDomains()	Get a list of domains to which this subsystem is bound.
java.lang.String	getInstanceTypeId()	Get the instance type id of this Subsystem
java.lang.String	getName()	Get subsystem name
boolean	isLocked()	Whether this subsystem is locked? Users can not login into a locked subsystem.
boolean	isReadOnly()	Whether this Subsystem is read only? Users can not make changes to the persistence of a read-only subsystem.
boolean	isSystem()	Is this instance a system or subsystem instance?
void	setAccessCtrl(Instance.AccessCtrl accessCtrl)	Set subsystem access control that can be read only, locked, or read-write.
void	setBoundDomains(java.util.List<BoundDomain> boundDomains)	Set a list of domains to which this subsystem is bound.
void	setInstanceTypeId(java.lang.String instanceTypeId)	Set the instance type id of this Instance
void	setName(java.lang.String name)	Set subsystem name
void	setSystem(boolean system)	Set whether this instance is a system or subsystem instance.

Methods inherited from interface com.znize.platform.entity.CreatedDateAware

getCreatedDate, setCreatedDate

Methods inherited from interface com.znize.platform.entity.CreatorAware

getCreator, setCreator

Methods inherited from interface com.znize.platform.entity.NormativeId

getNid, setNid

Methods inherited from interface com.znize.platform.entity.PersistenceEntity

clone, getId, getInstance, getSequenceNo, getVersion, isChanged, isPartiallyInitialized, isPersisted, isSelected, isStatistics, setChanged, setId, setInstance, setPartiallyInitialized, setPersisted, setSelected, setSequenceNo, setStatistics, setVersion

Field Detail

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME

Property name: name

See Also:

Constant Field Values

PROPERTY_INSTANCE_TYPE_ID

static final java.lang.String PROPERTY_INSTANCE_TYPE_ID

Property name: type

See Also:

Constant Field Values

PROPERTY_ACCESS_CTRL

static final java.lang.String PROPERTY_ACCESS_CTRL

Property name: accessCtrl

See Also:

Constant Field Values

PROPERTY_BOUND_DOMAINS

static final java.lang.String PROPERTY_BOUND_DOMAINS

Property name: boundDomains

See Also:

Constant Field Values

Method Detail

isSystem

boolean isSystem()

Is this instance a system or subsystem instance?

Returns:

true for system, false for subsystem.

Since:

5.7

setSystem

void setSystem(boolean system)

Set whether this instance is a system or subsystem instance.

Parameters:

system - true for system, false for subsystem.

Since:

5.7

getName

java.lang.String getName()

Get subsystem name

Returns:

subsystem name

setName

void setName(java.lang.String name)

Set subsystem name

Parameters:

name - the name to set

getInstanceTypeId

java.lang.String getInstanceTypeId()

Get the instance type id of this Subsystem

Returns:

the id of its InstanceType

setInstanceTypeId

void setInstanceTypeId(java.lang.String instanceTypeId)

Set the instance type id of this Instance

Parameters:

instanceTypeId - the id of its InstanceType

getAccessCtrl

Instance.AccessCtrl getAccessCtrl()

Get subsystem access control that can be read only, locked, or read-write.

Returns:

access control

setAccessCtrl

void setAccessCtrl(Instance.AccessCtrl accessCtrl)

Set subsystem access control that can be read only, locked, or read-write.

Parameters:

accessCtrl - the AccessCtrl to set

isReadOnly

boolean isReadOnly()

Whether this Subsystem is read only? Users can not make changes to the persistence of a read-only subsystem.

Returns:

true if its access control is Instance.AccessCtrl.READ_ONLY.

isLocked

boolean isLocked()

Whether this subsystem is locked? Users can not login into a locked subsystem.

Returns:

true if its access control is Instance.AccessCtrl.LOCKED.

getBoundDomains

java.util.List<BoundDomain> getBoundDomains()

Get a list of domains to which this subsystem is bound.

Returns:

a list of BoundDomain(s).

setBoundDomains

void setBoundDomains(java.util.List<BoundDomain> boundDomains)

Set a list of domains to which this subsystem is bound.

Parameters:

boundDomains - a list of BoundDomain(s).

addBoundDomain

void addBoundDomain(BoundDomain boundDomain)

Add the bound domain.

Parameters:

boundDomain - the domain to add