Package org.gbif.api.model.collections
Class Institution
java.lang.Object
org.gbif.api.model.collections.Institution
- All Implemented Interfaces:
Serializable
,CollectionEntity
,Contactable
,OccurrenceMappeable
,Commentable
,Identifiable
,LenientEquals<Institution>
,MachineTaggable
,Taggable
The owner or location of collection. Usually an established organization or foundation,
especially one dedicated to education, public service, or culture.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addMachineTag
(MachineTag machineTag) @Valid Address
Physical or associated address.Alternative codes for an institution.Machine-consumable endpoint of an institution and probably its collections.URL to the main catalogue of an institution.getCity()
@NotNull(groups=PrePersist.class) String
getCode()
Code used to identify the collection.List of associated contacts.Date when the records as created.Creator of the database record.Date when the records was (logically) deleted.@Size(min=1) String
Textual description of institution.Flag to display the entity in the NHC portal.getEmail()
Emails of the entityURL to the home page of an institution.getKey()
GBIF unique identifier.Logo/Image that identifies the institution.@NotNull List<MachineTag>
@Valid Address
Address used to send and receive mail.Master source of the entity.Master source metadataDate when the records was last modified.Person or agent that modified the database record.@NotNull String
getName()
Name or title of an institution.getPhone()
Phones of the entityReplacement of the entity (if applies).getTags()
boolean
isActive()
Is the institution active/operational?.boolean
lenientEquals
(Institution other) Leniently tests if the objects are the same.void
setActive
(boolean active) void
setAddress
(Address address) void
setAlternativeCodes
(List<AlternativeCode> alternativeCodes) void
void
setComments
(List<Comment> comments) void
setContactPersons
(List<Contact> contactPersons) void
setCreated
(Date created) void
setCreatedBy
(String createdBy) void
setDeleted
(Date deleted) void
setDescription
(String description) void
setDisplayOnNHCPortal
(Boolean displayOnNHCPortal) void
void
setFeaturedImageAttribution
(String featuredImageAttribution) void
setFeaturedImageLicense
(License featuredImageLicense) void
setFeaturedImageUrl
(URI featuredImageUrl) void
setIdentifiers
(List<Identifier> identifiers) void
void
setMachineTags
(List<MachineTag> machineTags) void
setMailingAddress
(Address mailingAddress) void
setMasterSource
(MasterSourceType masterSource) void
setMasterSourceMetadata
(MasterSourceMetadata masterSourceMetadata) void
setModified
(Date modified) void
setModifiedBy
(String modifiedBy) void
void
setOccurrenceMappings
(List<OccurrenceMapping> occurrenceMappings) void
void
setReplacedBy
(UUID replacedBy) void
-
Constructor Details
-
Institution
public Institution()
-
-
Method Details
-
getKey
GBIF unique identifier.- Specified by:
getKey
in interfaceCollectionEntity
-
setKey
- Specified by:
setKey
in interfaceCollectionEntity
-
getCode
Code used to identify the collection.- Specified by:
getCode
in interfaceCollectionEntity
-
setCode
- Specified by:
setCode
in interfaceCollectionEntity
-
getName
Name or title of an institution.- Specified by:
getName
in interfaceCollectionEntity
-
setName
- Specified by:
setName
in interfaceCollectionEntity
-
getDescription
Textual description of institution.- Specified by:
getDescription
in interfaceCollectionEntity
-
setDescription
- Specified by:
setDescription
in interfaceCollectionEntity
-
isActive
Is the institution active/operational?.- Specified by:
isActive
in interfaceCollectionEntity
-
setActive
- Specified by:
setActive
in interfaceCollectionEntity
-
getEmail
Description copied from interface:CollectionEntity
Emails of the entity- Specified by:
getEmail
in interfaceCollectionEntity
-
setEmail
- Specified by:
setEmail
in interfaceCollectionEntity
-
getPhone
Description copied from interface:CollectionEntity
Phones of the entity- Specified by:
getPhone
in interfaceCollectionEntity
-
setPhone
- Specified by:
setPhone
in interfaceCollectionEntity
-
getHomepage
URL to the home page of an institution. -
getCatalogUrls
URL to the main catalogue of an institution. -
getApiUrls
Machine-consumable endpoint of an institution and probably its collections. -
getMailingAddress
Description copied from interface:Contactable
Address used to send and receive mail.- Specified by:
getMailingAddress
in interfaceContactable
-
setMailingAddress
- Specified by:
setMailingAddress
in interfaceContactable
-
getAddress
Description copied from interface:Contactable
Physical or associated address.- Specified by:
getAddress
in interfaceContactable
-
setAddress
- Specified by:
setAddress
in interfaceContactable
-
getLogoUrl
Logo/Image that identifies the institution. -
getCreatedBy
Description copied from interface:CollectionEntity
Creator of the database record.- Specified by:
getCreatedBy
in interfaceCollectionEntity
-
setCreatedBy
- Specified by:
setCreatedBy
in interfaceCollectionEntity
-
getModifiedBy
Description copied from interface:CollectionEntity
Person or agent that modified the database record.- Specified by:
getModifiedBy
in interfaceCollectionEntity
-
setModifiedBy
- Specified by:
setModifiedBy
in interfaceCollectionEntity
-
getCreated
Description copied from interface:CollectionEntity
Date when the records as created.- Specified by:
getCreated
in interfaceCollectionEntity
-
setCreated
- Specified by:
setCreated
in interfaceCollectionEntity
-
getModified
Description copied from interface:CollectionEntity
Date when the records was last modified.- Specified by:
getModified
in interfaceCollectionEntity
-
setModified
- Specified by:
setModified
in interfaceCollectionEntity
-
getDeleted
Description copied from interface:CollectionEntity
Date when the records was (logically) deleted.- Specified by:
getDeleted
in interfaceCollectionEntity
-
setDeleted
- Specified by:
setDeleted
in interfaceCollectionEntity
-
getIdentifiers
- Specified by:
getIdentifiers
in interfaceIdentifiable
-
setIdentifiers
- Specified by:
setIdentifiers
in interfaceIdentifiable
-
getTags
-
setTags
-
getContactPersons
Description copied from interface:Contactable
List of associated contacts.- Specified by:
getContactPersons
in interfaceContactable
-
setContactPersons
- Specified by:
setContactPersons
in interfaceContactable
-
getMachineTags
- Specified by:
getMachineTags
in interfaceMachineTaggable
-
setMachineTags
- Specified by:
setMachineTags
in interfaceMachineTaggable
-
addMachineTag
- Specified by:
addMachineTag
in interfaceMachineTaggable
-
getAlternativeCodes
Alternative codes for an institution.- Specified by:
getAlternativeCodes
in interfaceCollectionEntity
-
setAlternativeCodes
- Specified by:
setAlternativeCodes
in interfaceCollectionEntity
-
getComments
- Specified by:
getComments
in interfaceCommentable
-
setComments
- Specified by:
setComments
in interfaceCommentable
-
getOccurrenceMappings
- Specified by:
getOccurrenceMappings
in interfaceOccurrenceMappeable
-
setOccurrenceMappings
- Specified by:
setOccurrenceMappings
in interfaceOccurrenceMappeable
-
getReplacedBy
Description copied from interface:CollectionEntity
Replacement of the entity (if applies).- Specified by:
getReplacedBy
in interfaceCollectionEntity
-
setReplacedBy
- Specified by:
setReplacedBy
in interfaceCollectionEntity
-
getMasterSource
Description copied from interface:CollectionEntity
Master source of the entity.- Specified by:
getMasterSource
in interfaceCollectionEntity
-
setMasterSource
- Specified by:
setMasterSource
in interfaceCollectionEntity
-
getMasterSourceMetadata
Description copied from interface:CollectionEntity
Master source metadata- Specified by:
getMasterSourceMetadata
in interfaceCollectionEntity
-
setMasterSourceMetadata
- Specified by:
setMasterSourceMetadata
in interfaceCollectionEntity
-
getDisplayOnNHCPortal
Description copied from interface:CollectionEntity
Flag to display the entity in the NHC portal.- Specified by:
getDisplayOnNHCPortal
in interfaceCollectionEntity
-
setDisplayOnNHCPortal
- Specified by:
setDisplayOnNHCPortal
in interfaceCollectionEntity
-
getFeaturedImageUrl
- Specified by:
getFeaturedImageUrl
in interfaceCollectionEntity
-
setFeaturedImageUrl
- Specified by:
setFeaturedImageUrl
in interfaceCollectionEntity
-
getFeaturedImageLicense
- Specified by:
getFeaturedImageLicense
in interfaceCollectionEntity
-
setFeaturedImageLicense
- Specified by:
setFeaturedImageLicense
in interfaceCollectionEntity
-
getFeaturedImageAttribution
- Specified by:
getFeaturedImageAttribution
in interfaceCollectionEntity
-
setFeaturedImageAttribution
- Specified by:
setFeaturedImageAttribution
in interfaceCollectionEntity
-
getCountry
-
getCity
-
getProvince
-
lenientEquals
Description copied from interface:LenientEquals
Leniently tests if the objects are the same. Implementors should declare what this means in practice.- Specified by:
lenientEquals
in interfaceLenientEquals<Institution>
- Parameters:
other
- To compare against- Returns:
- true if...
-