org.opengroupware.jogi.connect.xmlrpc
Class XmlRpcAccount

java.lang.Object
  java.util.Observable
      org.opengroupware.jogi.connect.xmlrpc.XmlRpcBaseDocument
          org.opengroupware.jogi.connect.xmlrpc.XmlRpcAccount

All Implemented Interfaces:

Account

public class XmlRpcAccount

extends XmlRpcBaseDocument

implements Account

Author:

Werner Schuster (murphee)

Field Summary

protected XmlRpcCaller	caller_
static java.lang.String	KEY_LOGIN
static java.lang.String	OGO_CALL_ACCOUNT_GET_PASSWORD_BY_LOGIN
static java.lang.String	OGO_CALL_ACCOUNT_SET_PASSWORD
protected OpenGroupWare	openGroupware_

Fields inherited from class org.opengroupware.jogi.connect.xmlrpc.XmlRpcBaseDocument

content_, id_, KEY_ID

Constructor Summary

protected	XmlRpcAccount(XmlRpcCaller caller, java.util.Map contents, OpenGroupWare ogo)
protected	XmlRpcAccount(XmlRpcCaller caller, java.lang.String login, java.lang.String id, OpenGroupWare ogo)

Method Summary

protected boolean	checkNewContent(java.util.Map new_content) This method checks whether the provided Map contains a valid document.
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	getLogin()
java.util.List	getMailTransactions()
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)

Methods inherited from class org.opengroupware.jogi.connect.xmlrpc.XmlRpcBaseDocument

fireNotify, getContent, getId, getString, put, setContent

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opengroupware.jogi.ogo.Account

getId

Field Detail

KEY_LOGIN

public static final java.lang.String KEY_LOGIN

See Also:

Constant Field Values

OGO_CALL_ACCOUNT_SET_PASSWORD

public static final java.lang.String OGO_CALL_ACCOUNT_SET_PASSWORD

See Also:

Constant Field Values

OGO_CALL_ACCOUNT_GET_PASSWORD_BY_LOGIN

public static final java.lang.String OGO_CALL_ACCOUNT_GET_PASSWORD_BY_LOGIN

See Also:

Constant Field Values

caller_

protected XmlRpcCaller caller_

openGroupware_

protected OpenGroupWare openGroupware_

Constructor Detail

XmlRpcAccount

protected XmlRpcAccount(XmlRpcCaller caller,
                        java.lang.String login,
                        java.lang.String id,
                        OpenGroupWare ogo)
                 throws OgoException,
                        ConnectionException

XmlRpcAccount

protected XmlRpcAccount(XmlRpcCaller caller,
                        java.util.Map contents,
                        OpenGroupWare ogo)

Method Detail

getLogin

public java.lang.String getLogin()

Specified by:

getLogin in interface Account

setPassword

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

Specified by:

setPassword in interface Account

Throws:

OgoException

ConnectionException

getPassword

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

Specified by:

getPassword in interface Account

Throws:

OgoException

ConnectionException

getTodoList

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

Description copied from interface: Account

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

Specified by:

getTodoList in interface 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

Description copied from interface: Account

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

Specified by:

getTodoListAsIds in interface 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

Description copied from interface: Account

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

Specified by:

getDelegatedJobs in interface 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

Description copied from interface: Account

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

Specified by:

getDelegatedJobsAsIds in interface 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

Description copied from interface: Account

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

Specified by:

getArchivedJobs in interface 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

Description copied from interface: Account

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

Specified by:

getArchivedJobsAsIds in interface 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

getMailTransactions

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

Throws:

OgoException

ConnectionException

checkNewContent

protected boolean checkNewContent(java.util.Map new_content)

Description copied from class: XmlRpcBaseDocument

This method checks whether the provided Map contains a valid document. If essential parts are missing or are of a wrong type, this method must return false, otherwise true.

Specified by:

checkNewContent in class XmlRpcBaseDocument

Parameters:

new_content - The new content for the document.

Returns:

true if the content meets all requirements, otherwise false.

getPerson

public Person getPerson()
                 throws OgoException,
                        ConnectionException

Description copied from interface: Account

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

Specified by:

getPerson in interface Account

Returns:

Person object

Throws:

OgoException

ConnectionException