org.richfaces.photoalbum.domain

Class Shelf

java.lang.Object

org.richfaces.photoalbum.domain.Shelf

All Implemented Interfaces:

Serializable

@Entity
public class Shelf
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Shelf()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlbum(Album album) This method add album to collection of albums of current shelf
boolean	equals(Object obj)
List<Album>	getAlbums()
Date	getCreated()
String	getDescription()
Event	getEvent()
Album	getFirstAlbum() This method return first album of current shelf or null if shelf haven't albums.
Long	getId()
List<Image>	getImages()
String	getName() Getter for property name
User	getOwner()
String	getPath() Return relative path of this shelf in file-system(relative to uploadRoot parameter)
List<Image>	getUnvisitedImages()
int	hashCode()
boolean	isOwner(User user)
boolean	isPreDefined() Getter for property preDefined
boolean	isShared() Getter for property shared.
void	removeAlbum(Album album) This method remove album from collection of albums of album
void	setCreated(Date created)
void	setDescription(String description)
void	setEvent(Event event)
void	setName(String name)
void	setOwner(User owner)
void	setShared(boolean shared) Setter for property shared
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Shelf

public Shelf()

Method Detail

isPreDefined

public boolean isPreDefined()

Getter for property preDefined

Returns:

is this shelf is predefined

getId

public Long getId()

getName

public String getName()

Getter for property name

Returns:

name of album

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getAlbums

public List<Album> getAlbums()

getOwner

public User getOwner()

setOwner

public void setOwner(User owner)

isOwner

public boolean isOwner(User user)

getCreated

public Date getCreated()

setCreated

public void setCreated(Date created)

isShared

public boolean isShared()

Getter for property shared. If true - all users can view this shelves and albums and images, contained in this shelf, otherwise this shelf can view only owner.

Returns:

shared

setShared

public void setShared(boolean shared)

Setter for property shared

Parameters:

shared - - determine is this shelf will be accessible by other users.

getUnvisitedImages

public List<Image> getUnvisitedImages()

Returns:

List of unvisited images

getImages

public List<Image> getImages()

Returns:

List of images, belongs to this shelf

addAlbum

public void addAlbum(Album album)

This method add album to collection of albums of current shelf

Parameters:

album - - album to add

removeAlbum

public void removeAlbum(Album album)

This method remove album from collection of albums of album

Parameters:

album - - album to remove

getFirstAlbum

public Album getFirstAlbum()

This method return first album of current shelf or null if shelf haven't albums.

Returns:

first album of shelf or null

getPath

public String getPath()

Return relative path of this shelf in file-system(relative to uploadRoot parameter)

getEvent

public Event getEvent()

setEvent

public void setEvent(Event event)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object