Package com.cmobilecom.af.entity.system

Interface Instance

  • All Superinterfaces:
    java.lang.Cloneable, CreatedDateAware, CreatorAware, PersistenceEntity
    public interface Instance
extends PersistenceEntity, CreatorAware
    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

    • 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