SystemPlugin (formcycle: bom 8.3.5 API)

java.lang.Object
- de.xima.cmn.dao.model.AEntity<Long>
- - de.xima.fc.entities.AbstractEntity
  - - de.xima.fc.entities.AbstractLockableEntity
    - - de.xima.fc.entities.ALockableEntity
      - de.xima.fc.entities.APluginEntity<SystemPluginFile,SystemPluginFileData,SystemPluginConfigData>
        
        de.xima.fc.entities.SystemPlugin

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, ILockingVersionProviding, INameProviding, IPluginEntity<SystemPluginFile,SystemPluginFileData,SystemPluginConfigData>, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
```
@Entity
public class SystemPlugin
extends APluginEntity<SystemPluginFile,SystemPluginFileData,SystemPluginConfigData>
```
Entity for system-wide plugins

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected SystemPluginFile fileEntity
- Fields inherited from class de.xima.fc.entities.APluginEntity
  active, ATTR_ACTIVE, ATTR_PLUGIN_FILE_KEY, ATTR_PLUGIN_KEY, ATTR_PLUGIN_REPOSITORY, ATTR_REMOTE_SYNC, COL_ACTIVE, COL_PLUGIN_FILE_KEY, COL_PLUGIN_KEY, COL_PLUGIN_REPOSITORY, COL_REMOTE_SYNC, COL_RESTRICT_SERVER_TYPE, COL_UUID, description, name, pluginFileKey, pluginKey, pluginRepository, remoteSync, serverRestrictionType, uuid
- Fields inherited from class de.xima.fc.entities.AbstractLockableEntity
  COL_LOCKINGVERSION, lockingVersion
- Fields inherited from class de.xima.fc.entities.AbstractEntity
  COL_ID, id
- Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding
  ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION
- Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity
  ATTR_ID
- Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity
  ATTR_LOCKINGVERSION
- Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
  ATTR_NAME, COL_NAME
- Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity
  IMPORT_ID, INVALID_ID
- Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity
  ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors
Constructor Description

SystemPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SystemPluginFile`	`getFileEntity()`
`Long`	`getId()`
`String`	`getScopeKey()`
`void`	`setFileEntity(SystemPluginFile fileEntity)`
`void`	`setId(Long id)`	!!!WARNING: Currently values bigger `Integer.MAX_VALUE` or lower then `Integer.MIN_VALUE` will be altered to null!!!

Methods inherited from class de.xima.fc.entities.APluginEntity
getBeschreibung, getName, getPluginFileKey, getPluginId, getPluginKey, getPluginRepository, getRuntimeKey, getServerRestrictionType, getUUID, getUUIDObject, isActive, isRemoteSync, setActive, setBeschreibung, setName, setPluginFileKey, setPluginKey, setPluginRepository, setRemoteSync, setServerRestrictionType, setUUID, setUUIDObject

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity
entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class de.xima.fc.entities.AbstractEntity
asIntValue, isPersisted, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity
compareTo, equals, getDBTableName, hashCode

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

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding
getDescription

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity
isPersisted

- Field Detail
  - fileEntity
```
protected SystemPluginFile fileEntity
```
- Constructor Detail
  - SystemPlugin
```
public SystemPlugin()
```
- Method Detail
  - getId
```
public Long getId()
```
  - setId
```
public void setId(Long id)
```
    Description copied from class: AbstractEntity
    
    !!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
    
    Specified by:
    
    setId in interface de.xima.cmn.dao.interfaces.IEntity<Long>
    
    Overrides:
    
    setId in class AbstractEntity
    
    Parameters:
    
    id - Long the database-id to set
  - getFileEntity
```
public SystemPluginFile getFileEntity()
```
    Returns:
    
    File entity with the file meta data of the plugin file, such as the file size.
  - setFileEntity
```
public void setFileEntity(SystemPluginFile fileEntity)
```
  - getScopeKey
```
public String getScopeKey()
```
    Returns:
    
    The scope key of this plugin, either the client UUID for client-scoped plugins or SYSTEM_SCOPE_KEY for system scoped plugins.