com.thindeck.api

Interface Base

All Known Implementing Classes:

DyBase, FkBase

@Immutable
public interface Base

Base of the entire system.

Base is an entry point to the entire object model of the system. You start from getting an instance of this type from somewhere (depends on the implementation) and then use one of the users or decks.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@teamed.io)

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Deck>	active() Get active decks, no matter what users they belong to.
User	user(String name) Get user by name.

Method Detail

user

@NotNull(message="user can\'t be null")
User user(String name)

Get user by name.

If the user is absent, it should be automatically created and returned.

Parameters:

name - His name

Returns:

User found or created

active

@NotNull(message="Decks can\'t be null")
Iterable<Deck> active()
                      throws IOException

Get active decks, no matter what users they belong to.

This method is used only by a system-wide routine procedure that goes through ALL decks.

Returns:

Decks

Throws:

IOException - If fails