IridaThing (irida 22.09 API)

All Superinterfaces:

Timestamped<java.lang.Long>

All Known Subinterfaces:

Join<SubjectType,ObjectType>, MutableIridaThing

All Known Implementing Classes:

AbstractAnalysisSubmission, Analysis, AnalysisFastQC, AnalysisOutputFile, AnalysisSubmission, AnalysisSubmissionTemplate, Announcement, AnnouncementUserJoin, DataAddedToSampleProjectEvent, Fast5Object, GenomeAssembly, GenomeAssemblyFromAnalysis, IridaClientDetails, IridaWorkflowNamedParameters, JobError, MetadataTemplate, NcbiExportSubmission, OverrepresentedSequence, Project, ProjectAnalysisSubmissionJoin, ProjectEvent, ProjectReferenceFileJoin, ProjectSampleJoin, ProjectSubscription, ProjectUserJoin, ReferenceFile, RelatedProjectJoin, RemoteAPI, Sample, SampleAddedProjectEvent, SampleGenomeAssemblyJoin, SampleRemovedProjectEvent, SampleSequencingObjectJoin, SequenceConcatenation, SequenceFile, SequenceFilePair, SequencingObject, SequencingRun, SingleEndSequenceFile, ToolExecution, UploadedAssembly, User, UserGroup, UserGroupJoin, UserGroupProjectJoin, UserGroupRemovedProjectEvent, UserGroupRoleSetProjectEvent, UserRemovedProjectEvent, UserRoleSetProjectEvent
```
public interface IridaThing
extends Timestamped<java.lang.Long>
```
An interface for all model classes in the IRIDA system. By default, all objects in IRIDA are considered to be immutable. If your object allows mutation, please extend MutableIridaThing.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.lang.Long`	`getId()`	Get the numerical identifier for this object
`default java.lang.String`	`getIdentifier()`	Get the id parameter as a string.
`@NotNull(message="{irida.label.notnull}") java.lang.String`	`getLabel()`	Get a human readable label for this object.
`default void`	`setLabel(java.lang.String label)`	Method supporting JSON deserialzation.

Methods inherited from interface ca.corefacility.bioinformatics.irida.model.Timestamped
getCreatedDate

- Method Detail
  - getLabel
```
@NotNull(message="{irida.label.notnull}")
@NotNull(message="{irida.label.notnull}") java.lang.String getLabel()
```
    Get a human readable label for this object.
    
    Returns:
    
    a human-readable label for the object.
  - setLabel
```
default void setLabel(java.lang.String label)
               throws java.lang.UnsupportedOperationException
```
    Method supporting JSON deserialzation. This method should not be used and will throw UnsupportedOperationException when called.
    
    Parameters:
    
    label - label param
    
    Throws:
    
    java.lang.UnsupportedOperationException - A label cannot be set for an object. It should be computed from the object's properties.
  - getId
```
java.lang.Long getId()
```
    Get the numerical identifier for this object
    
    Specified by:
    
    getId in interface Timestamped<java.lang.Long>
    
    Returns:
    
    the numerical identifier for the object
  - getIdentifier
```
default java.lang.String getIdentifier()
```
    Get the id parameter as a string. This method is here to ensure compatibility with previous clients which use the IRIDA REST API. It may be removed once APIv2 is released.
    
    Returns:
    
    A String version of the identifier