Package org.gbif.api.model.collections

Interface CollectionEntity

All Superinterfaces:

Commentable, Contactable, Identifiable, MachineTaggable, OccurrenceMappeable, Serializable, Taggable

All Known Implementing Classes:

Collection, Institution

public interface CollectionEntity
extends Contactable, Taggable, MachineTaggable, Identifiable, Commentable, OccurrenceMappeable, Serializable

Entity .

Method Summary

Modifier and Type	Method	Description
List<AlternativeCode>	getAlternativeCodes()	Alternative codes of the entity
@NotNull(groups=PrePersist.class) String	getCode()	Identifies an entity at the owner's location.
Date	getCreated()	Date when the records as created.
String	getCreatedBy()	Creator of the database record.
Date	getDeleted()	Date when the records was (logically) deleted.
@Size(min=1) String	getDescription()	Textual description/summary of the contents of an entity.
Boolean	getDisplayOnNHCPortal()	Flag to display the entity in the NHC portal.
List<String>	getEmail()	Emails of the entity
String	getFeaturedImageAttribution()
License	getFeaturedImageLicense()
URI	getFeaturedImageUrl()
UUID	getKey()	Unique identifier.
MasterSourceType	getMasterSource()	Master source of the entity.
MasterSourceMetadata	getMasterSourceMetadata()	Master source metadata
Date	getModified()	Date when the records was last modified.
String	getModifiedBy()	Person or agent that modified the database record.
@NotNull String	getName()	Descriptive name of an entity.
List<String>	getPhone()	Phones of the entity
UUID	getReplacedBy()	Replacement of the entity (if applies).
boolean	isActive()	Is this entity currently active/maintained.
void	setActive(boolean active)
void	setAlternativeCodes(List<AlternativeCode> alternativeCodes)
void	setCode(String code)
void	setCreated(Date created)
void	setCreatedBy(String createdBy)
void	setDeleted(Date deleted)
void	setDescription(String description)
void	setDisplayOnNHCPortal(Boolean displayOnNHCPortal)
void	setEmail(List<String> email)
void	setFeaturedImageAttribution(String featuredImageAttribution)
void	setFeaturedImageLicense(License featuredImageLicense)
void	setFeaturedImageUrl(URI featuredImageUrl)
void	setKey(UUID key)
void	setMasterSource(MasterSourceType masterSource)
void	setMasterSourceMetadata(MasterSourceMetadata masterSourceMetadata)
void	setModified(Date modified)
void	setModifiedBy(String modifiedBy)
void	setName(String name)
void	setPhone(List<String> phone)
void	setReplacedBy(UUID replacedBy)

Methods inherited from interface org.gbif.api.model.registry.Commentable

getComments, setComments

Methods inherited from interface org.gbif.api.model.collections.Contactable

getAddress, getContactPersons, getMailingAddress, setAddress, setContactPersons, setMailingAddress

Methods inherited from interface org.gbif.api.model.registry.Identifiable

getIdentifiers, setIdentifiers

Methods inherited from interface org.gbif.api.model.registry.MachineTaggable

addMachineTag, getMachineTags, setMachineTags

Methods inherited from interface org.gbif.api.model.collections.OccurrenceMappeable

getOccurrenceMappings, setOccurrenceMappings

Methods inherited from interface org.gbif.api.model.registry.Taggable

getTags, setTags

Method Details

getKey

UUID getKey()

Unique identifier.

setKey

void setKey(UUID key)

getCreatedBy

String getCreatedBy()

Creator of the database record.

setCreatedBy

void setCreatedBy(String createdBy)

getModifiedBy

String getModifiedBy()

Person or agent that modified the database record.

setModifiedBy

void setModifiedBy(String modifiedBy)

getCreated

Date getCreated()

Date when the records as created.

setCreated

void setCreated(Date created)

getModified

Date getModified()

Date when the records was last modified.

setModified

void setModified(Date modified)

getDeleted

@Nullable
Date getDeleted()

Date when the records was (logically) deleted.

setDeleted

void setDeleted(Date deleted)

getCode

@NotNull(groups=PrePersist.class)
@NotNull(groups=PrePersist.class) String getCode()

Identifies an entity at the owner's location.

setCode

void setCode(String code)

getName

@NotNull
@NotNull String getName()

Descriptive name of an entity.

setName

void setName(String name)

getDescription

@Size(min=1)
@Size(min=1) String getDescription()

Textual description/summary of the contents of an entity.

setDescription

void setDescription(String description)

isActive

boolean isActive()

Is this entity currently active/maintained.

setActive

void setActive(boolean active)

getReplacedBy

UUID getReplacedBy()

Replacement of the entity (if applies).

setReplacedBy

void setReplacedBy(UUID replacedBy)

getMasterSource

MasterSourceType getMasterSource()

Master source of the entity.

setMasterSource

void setMasterSource(MasterSourceType masterSource)

getMasterSourceMetadata

MasterSourceMetadata getMasterSourceMetadata()

Master source metadata

setMasterSourceMetadata

void setMasterSourceMetadata(MasterSourceMetadata masterSourceMetadata)

getDisplayOnNHCPortal

Boolean getDisplayOnNHCPortal()

Flag to display the entity in the NHC portal.

setDisplayOnNHCPortal

void setDisplayOnNHCPortal(Boolean displayOnNHCPortal)

getEmail

List<String> getEmail()

Emails of the entity

setEmail

void setEmail(List<String> email)

getPhone

List<String> getPhone()

Phones of the entity

setPhone

void setPhone(List<String> phone)

getAlternativeCodes

List<AlternativeCode> getAlternativeCodes()

Alternative codes of the entity

setAlternativeCodes

void setAlternativeCodes(List<AlternativeCode> alternativeCodes)

getFeaturedImageUrl

@Nullable
URI getFeaturedImageUrl()

setFeaturedImageUrl

void setFeaturedImageUrl(URI featuredImageUrl)

getFeaturedImageLicense

@Nullable
License getFeaturedImageLicense()

setFeaturedImageLicense

void setFeaturedImageLicense(License featuredImageLicense)

getFeaturedImageAttribution

@Nullable
String getFeaturedImageAttribution()

setFeaturedImageAttribution

void setFeaturedImageAttribution(String featuredImageAttribution)