Interface IScopedFileMetaEntity<TBase extends de.xima.cmn.dao.interfaces.IEntity<Long>, TData extends IFileDataEntity<?>>

Type Parameters:

TBase - type of the base entity determines the type this file meta entity can be attached to.

TData - type of the data entity that stores the actual file data.

All Superinterfaces:

Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>, de.xima.cmn.dao.interfaces.IEntity<Long>, IFileMetaEntity<TBase,TData>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable

All Known Subinterfaces:

ILocalizedScopedFileMetaEntity<TBase,TData>

All Known Implementing Classes:

ALocalizedScopedFileMetaEntity, AScopedFileMetaEntity, ProjectFile, UserPortalFile

public interface IScopedFileMetaEntity<TBase extends de.xima.cmn.dao.interfaces.IEntity<Long>, TData extends IFileDataEntity<?>>
extends IFileMetaEntity<TBase,TData>

Common interface for the metadata of a scoped file. Scoped files provide a file key by which they are scoped.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_FILE_KEY	JPA attribute name for the getFileKey() field.
static final String	COL_FILE_KEY	Database column name for the getFileKey() field.

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface IFileMetaEntity

ATTR_CREATED_TIMESTAMP, ATTR_ENTITY, ATTR_FILE_NAME, ATTR_FILE_SIZE, ATTR_MIME_TYPE, ATTR_MODIFIED_TIMESTAMP, ATTR_USER_NAME_CREATED, ATTR_USER_NAME_MODIFIED, COL_CREATED_TIMESTAMP, COL_ENTITY_ID, COL_FILE_NAME, COL_FILE_SIZE, COL_MIME_TYPE, COL_MODIFIED_TIMESTAMP, COL_USER_NAME_CREATED, COL_USER_NAME_MODIFIED

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface IUUIDEntity

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Method Summary

Modifier and Type	Method	Description
String	getFileKey()	Gets the key that determines the purpose of this file
void	setFileKey(String fileKey)	Sets the key that determines the purpose of this file

Methods inherited from interface Comparable

compareTo

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

getId, isPersisted, setId

Methods inherited from interface IFileMetaEntity

getBaseEntity, getCreatedInstant, getCreatorName, getDataEntity, getFileName, getFileSize, getMimeType, getModifiedInstant, getModifierName, setBaseEntity, setCreatedInstant, setCreatorName, setData, setFileName, setFileSize, setMimeType, setModifiedInstant, setModifierName

Methods inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

entityHasChanged, getLockingVersion, setLockingVersion

Methods inherited from interface ILockingVersionProviding

getLockingVersion

Methods inherited from interface IUUIDEntity

getUUID, getUUIDObject, setUUID

Field Details

ATTR_FILE_KEY

static final String ATTR_FILE_KEY

JPA attribute name for the getFileKey() field.

See Also:

• Constant Field Values

COL_FILE_KEY

static final String COL_FILE_KEY

Database column name for the getFileKey() field.

See Also:

• Constant Field Values

Method Details

getFileKey

String getFileKey()

Gets the key that determines the purpose of this file

Returns:

file key

setFileKey

void setFileKey(String fileKey)

Sets the key that determines the purpose of this file

Parameters:

fileKey - determining the purpose of this file