edu.nrao.sss.model.source
Interface SourceCatalogEntry

All Superinterfaces:

CatalogItem<SourceCatalogEntry>, Cloneable, Identifiable, Nameable, NameableCatalogItem<SourceCatalogEntry>, UserAccountable

All Known Implementing Classes:

Source, SourceLookupTable

public interface SourceCatalogEntry
extends NameableCatalogItem<SourceCatalogEntry>, Identifiable, UserAccountable

An entry in a SourceCatalog.

Version Info:

$Revision: 2226 $

$Date: 2009-04-17 16:28:53 -0600 (Fri, 17 Apr 2009) $

$Author: dharland $ (last person to modify)

Since:

2006-09-15

Author:

David M. Harland

Field Summary

Fields inherited from interface edu.nrao.sss.util.Identifiable

UNIDENTIFIED

Fields inherited from interface edu.nrao.sss.model.UserAccountable

NULL_USER_ID

Method Summary

void	clearId() Resets this entry's ID, and the IDs of all its components, to a value that represents the unidentified state.
Source	get(Date pointInTime) Returns the source associated with this entry as of the given point in time.
String	getName() Returns the name of this entry.
List<String>	getNotes() Returns a list of notes about this entry.
void	setId(Long identifier) Do not use.
void	setName(String newName) Sets the name of this entry.

Methods inherited from interface edu.nrao.sss.catalog.CatalogItem

clone

Methods inherited from interface edu.nrao.sss.util.Identifiable

getId

Methods inherited from interface edu.nrao.sss.model.UserAccountable

getCreatedBy, getCreatedOn, getLastUpdatedBy, getLastUpdatedOn, setCreatedBy, setCreatedOn, setLastUpdatedBy, setLastUpdatedOn

Method Detail

setName

void setName(String newName)

Sets the name of this entry. If newName is null, this entry's name will be reset to its initial value.

Specified by:

setName in interface Nameable

Parameters:

newName - the new name for this entry.

getName

String getName()

Returns the name of this entry.

Specified by:

getName in interface Nameable

Returns:

the name of this entry.

setId

void setId(Long identifier)

Do not use. This method is here for the persistence mechanism. Other clients should not set object identifiers.

Parameters:

identifier -

clearId

void clearId()

Resets this entry's ID, and the IDs of all its components, to a value that represents the unidentified state.

This method is useful for preparing an entry for storage in a database. The ID property (as of now, though this may change in the future) is used by our persistence mechanism to identify objects. If you are persisting this entry for the first time, you may need to call this method before performing a save. This is especially true if you have created this source from XML, as the XML unmarshalling brings along the ID property.

getNotes

List<String> getNotes()

Returns a list of notes about this entry. Each note is free-form text with no particular structure.

Returns:

a list of notes about this entry.

get

Source get(Date pointInTime)

Returns the source associated with this entry as of the given point in time.

Parameters:

pointInTime - the time at which a source is desired.

Returns:

the source associated with this entry as of the given point in time.