Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class EntityReference

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.EntityReference

All Implemented Interfaces:

ICodeHolder, IEntityInformationHolder, IEntityInformationHolderWithPermId, IIdAndCodeHolder, IIdHolder, IPermIdHolder, java.io.Serializable

public class EntityReference
extends java.lang.Object
implements java.io.Serializable, IEntityInformationHolderWithPermId

Reference to an entity with minimal information to uniquely identify it in the database and to choose the right plugin to handle it.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityReference()
	EntityReference(long id, java.lang.String code, java.lang.String typeCode, EntityKind kind, java.lang.String permIdOrNull)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCode()	Returns the code.
EntityKind	getEntityKind()	Return the entity kind of this matching entity.
BasicEntityType	getEntityType()	Returns the entity type of this matching entity.
java.lang.Long	getId()	Returns the technical ID of this instance.
java.lang.String	getPermId()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityReference

protected EntityReference()

EntityReference

public EntityReference(long id,
                       java.lang.String code,
                       java.lang.String typeCode,
                       EntityKind kind,
                       java.lang.String permIdOrNull)

Method Detail

getEntityKind

public EntityKind getEntityKind()

Description copied from interface: IEntityInformationHolder

Return the entity kind of this matching entity.

Specified by:

getEntityKind in interface IEntityInformationHolder

getEntityType

public BasicEntityType getEntityType()

Description copied from interface: IEntityInformationHolder

Returns the entity type of this matching entity.

Specified by:

getEntityType in interface IEntityInformationHolder

getId

public java.lang.Long getId()

Description copied from interface: IIdHolder

Returns the technical ID of this instance.

Specified by:

getId in interface IIdHolder

Returns:

null if there is no Id.

getCode

public java.lang.String getCode()

Description copied from interface: ICodeHolder

Returns the code.

Specified by:

getCode in interface ICodeHolder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPermId

public java.lang.String getPermId()

Specified by:

getPermId in interface IPermIdHolder