com.softwarereality.forum
Interface MessageHome

All Known Implementing Classes:
JdbcMessageHome

public interface MessageHome

THIS FILE IS CODE GENERATED. MessageHome.java

See Also:
Message, MessageSession, MessageValidator

Method Summary
 int countByQuery(java.lang.Object query)
          Count the Beans using a String.
 Message create(Message message)
          Create just this Message in the store.
 java.util.Iterator findByAll()
          Find All the 'available' beans.
 java.util.Iterator findByForum(java.lang.Object forumID)
          Find the Message By Forum( java.lang.Object )
 Message findByPrimaryKey(java.lang.Object msgID)
          Find the Message By PrimaryKey( java.lang.Object )
 java.util.Iterator findByQuery(java.lang.Object query)
          Find the Beans using a String.
 java.util.Iterator findByQuery(java.lang.Object query, int maxRows)
          Find the Beans using a Query Object, with a maximum return row count.
 void load(Message message)
          Reload the Message based on it's primaryKey.
 void remove(Message msgID)
          Remove just this Message in the store.
 void store(Message message)
          Store just this Message in the store.
 

Method Detail

findByAll

public java.util.Iterator findByAll()
                             throws FinderException,
                                    ValidationException
Find All the 'available' beans.

Returns:
Iterator
Throws:
FinderException - If there was a problem finding any of the beans.
ValidationException - If there was a problem validating any of the beans.

findByForum

public java.util.Iterator findByForum(java.lang.Object forumID)
                               throws FinderException,
                                      ValidationException
Find the Message By Forum( java.lang.Object )

Returns:
Iterator The Bean/s that was found.
Throws:
FinderException - If there was a problem finding any of the beans.
ValidationException - If there was a problem validating any of the beans.

findByPrimaryKey

public Message findByPrimaryKey(java.lang.Object msgID)
                         throws FinderException,
                                ValidationException
Find the Message By PrimaryKey( java.lang.Object )

Returns:
Message The Bean/s that was found.
Throws:
FinderException - If there was a problem finding any of the beans.
ValidationException - If there was a problem validating any of the beans.

findByQuery

public java.util.Iterator findByQuery(java.lang.Object query)
                               throws FinderException,
                                      ValidationException
Find the Beans using a String.

Parameters:
query - A Query Object.toString(), usually an SQL query.
Returns:
Iterator
Throws:
FinderException - If there was a problem finding any of the beans.
ValidationException - If there was a problem validating any of the beans.

findByQuery

public java.util.Iterator findByQuery(java.lang.Object query,
                                      int maxRows)
                               throws FinderException,
                                      ValidationException
Find the Beans using a Query Object, with a maximum return row count.

Parameters:
query - A Query Object, usually an SQL String
maxRows - The maximum number of rows to return.
Returns:
Iterator
Throws:
FinderException - If there was a problem finding any of the beans.
ValidationException - If there was a problem validating any of the beans.

countByQuery

public int countByQuery(java.lang.Object query)
                 throws FinderException,
                        ValidationException
Count the Beans using a String.

Parameters:
query - A Query Object
Returns:
int the number of matching beans
Throws:
FinderException - If there was a problem finding any of the beans.
ValidationException - If there was a problem validating any of the beans.

load

public void load(Message message)
          throws LoadException,
                 ValidationException
Reload the Message based on it's primaryKey.

Throws:
LoadException - If there was a problem loading the Bean.
ValidationException - If there was a problem validating the Bean.

create

public Message create(Message message)
               throws CreateException,
                      ValidationException
Create just this Message in the store.

Throws:
CreateException - If there was a problem creating the Bean.
ValidationException - If there was a problem validating the Bean.

store

public void store(Message message)
           throws StoreException,
                  ValidationException
Store just this Message in the store.

Throws:
StoreException - If there was a problem storing the Bean.
ValidationException - If there was a problem validating the Bean.

remove

public void remove(Message msgID)
            throws RemoveException,
                   ValidationException
Remove just this Message in the store.

Throws:
RemoveException - If there was a problem removing the Bean.
ValidationException - If there was a problem validating the Bean.