org.opengroupware.jogi.ogo
Interface Account

All Known Implementing Classes:

XmlRpcAccount

public interface Account

Represents an Account. This class can only be generated by the AccountManager class, using one of its methods. The Account class notifies the AccountManager of any changes (the AccountManager is an Observer), which can then use the XML-RPC update function to update the data on the server. This allows to queue several update calls or other likewise optimizations.

Author:

Andreas Rath (teddius), Werner Schuster (murphee)

Method Summary

java.util.List	getArchivedJobs() Returns a List of Jobs that were marked as archived.
java.util.List	getArchivedJobsAsIds() Returns a List of Jobs that were marked as delegated.
java.util.List	getDelegatedJobs() Returns a List of Jobs that were marked as delegated.
java.util.List	getDelegatedJobsAsIds() Returns a List of Jobs that were marked as delegated.
java.lang.String	getId()
java.lang.String	getLogin()
java.lang.String	getPassword()
Person	getPerson() Gets the Person object that describes the owner of this Account.
java.util.List	getTodoList() Returns a List of Jobs that were marked as Todo.
java.util.List	getTodoListAsIds() Returns a List of Jobs that were marked as Todo.
void	setPassword(java.lang.String password)

Method Detail

getId

public java.lang.String getId()
                       throws OgoException,
                              ConnectionException

Throws:

OgoException

ConnectionException

getLogin

public java.lang.String getLogin()
                          throws OgoException,
                                 ConnectionException

Throws:

OgoException

ConnectionException

setPassword

public void setPassword(java.lang.String password)
                 throws OgoException,
                        ConnectionException

Throws:

OgoException

ConnectionException

getPassword

public java.lang.String getPassword()
                             throws OgoException,
                                    ConnectionException

Throws:

OgoException

ConnectionException

getTodoList

public java.util.List getTodoList()
                           throws OgoException,
                                  ConnectionException

Returns a List of Jobs that were marked as Todo. CAUTION: This only works if the used Account object is the Login Account!

Returns:

a List of Jobs, if no Jobs were found, an empty List is returned; if the Account object, that this method was invoked upon, is not the LoginAccount, the result is always null;

Throws:

OgoException

ConnectionException

getTodoListAsIds

public java.util.List getTodoListAsIds()
                                throws OgoException,
                                       ConnectionException

Returns a List of Jobs that were marked as Todo. CAUTION: This only works if the used Account object is the Login Account!

Returns:

a List of Strings, if no Jobs were found, an empty List is returned; if the Account object, that this method was invoked upon, is not the LoginAccount, the result is always null;

Throws:

OgoException

ConnectionException

getDelegatedJobs

public java.util.List getDelegatedJobs()
                                throws OgoException,
                                       ConnectionException

Returns a List of Jobs that were marked as delegated. CAUTION: This only works if the used Account object is the Login Account!

Returns:

a List of Jobs, if no Jobs were found, an empty List is returned; if the Account object, that this method was invoked upon, is not the LoginAccount, the result is always null;

Throws:

OgoException

ConnectionException

getDelegatedJobsAsIds

public java.util.List getDelegatedJobsAsIds()
                                     throws OgoException,
                                            ConnectionException

Returns a List of Jobs that were marked as delegated. CAUTION: This only works if the used Account object is the Login Account!

Returns:

a List of Strings, if no Jobs were found, an empty List is returned; if the Account object, that this method was invoked upon, is not the LoginAccount, the result is always null;

Throws:

OgoException

ConnectionException

getArchivedJobs

public java.util.List getArchivedJobs()
                               throws OgoException,
                                      ConnectionException

Returns a List of Jobs that were marked as archived. CAUTION: This only works if the used Account object is the Login Account!

Returns:

a List of Jobs, if no Jobs were found, an empty List is returned; if the Account object, that this method was invoked upon, is not the LoginAccount, the result is always null;

Throws:

OgoException

ConnectionException

getArchivedJobsAsIds

public java.util.List getArchivedJobsAsIds()
                                    throws OgoException,
                                           ConnectionException

Returns a List of Jobs that were marked as delegated. CAUTION: This only works if the used Account object is the Login Account!

Returns:

a List of Strings, if no Jobs were found, an empty List is returned; if the Account object, that this method was invoked upon, is not the LoginAccount, the result is always null;

Throws:

OgoException

ConnectionException

getPerson

public Person getPerson()
                 throws OgoException,
                        ConnectionException

Gets the Person object that describes the owner of this Account.

Returns:

Person object

Throws:

OgoException

ConnectionException