net.sf.basedb.core.data
Class ReporterTypeData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.ReporterTypeData

All Implemented Interfaces:

IdentifiableData, NameableData, RegisteredData, RemovableData

public class ReporterTypeData
extends BasicData
implements NameableData, RemovableData, RegisteredData

This class holds reporter type information. A reporter may have, but is not required to have a type. The main reason for a reporter to have a type is to make it easier for client application to filter the reporter list.

Version:

2.0

Author:

Nicklas, Samuel

See Also:

ReporterData, Developer documentation: Reporters

Hibernate: class

table="`ReporterTypes`" lazy="true"

Field Summary

private String	description
private Date	entryDate
private String	name
private boolean	removed
private Set<ReporterData>	reporter The reporters that have this type.

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

ReporterTypeData()
Default constructor.

Method Summary

String	getDescription() Get the description for the item.
Date	getEntryDate() Get the date this item was added to the database.
String	getName() Get the name of the item.
(package private) Set<ReporterData>	getReporters() This is the inverse end.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setEntryDate(Date entryDate)
void	setName(String name) Set the name of the item.
void	setRemoved(boolean removed) Set the removed flag for this item.
(package private) void	setReporters(Set<ReporterData> reporter) This is the inverse end.

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Field Detail

name

private String name

description

private String description

removed

private boolean removed

entryDate

private Date entryDate

reporter

private Set<ReporterData> reporter

The reporters that have this type.

Constructor Detail

ReporterTypeData

public ReporterTypeData()

Default constructor.

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getEntryDate

public Date getEntryDate()

Description copied from interface: RegisteredData

Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:

getEntryDate in interface RegisteredData

setEntryDate

public void setEntryDate(Date entryDate)

getReporters

Set<ReporterData> getReporters()

This is the inverse end. Get reporters.

Returns:

A set of ReporterData.

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`reportertype_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.ReporterData"

setReporters

void setReporters(Set<ReporterData> reporter)

This is the inverse end. Set reporters.

Parameters:

reporter - A set of ReporterData.