org.opengroupware.jogi.ogo
Interface Person

All Known Implementing Classes:

XmlRpcPerson

public interface Person

Represents a Person record. This is used to store contact information for individuals. As Jobs are Person specific, this class can also used for some Job management.

Author:

Andreas Rath (teddius) E-mail: arath@htu.tugraz.at

Method Summary

void	deleteJob(Job job)
void	deleteJob(java.lang.String id)
void	deleteJobs(java.util.List list)
java.util.List	fetch(FetchSpecification spec, int type)
java.util.List	fetchEnterprises(FetchSpecification fspec)
java.util.List	fetchJobs(FetchSpecification fspec)
java.util.List	fetchJobsAsIds(FetchSpecification fspec)
java.util.Map	getAddresses() Returns a Map with several adresses assigned to this Person.
java.util.Date	getBirthdate()
java.lang.String	getComment()
Account	getContact()
java.util.List	getEnterprises()
java.util.Map	getExtendedAttributs()
java.lang.String	getFirstName()
java.lang.String	getGender()
java.lang.String	getId()
java.lang.String	getKeywords()
java.lang.String	getLastName()
java.lang.String	getLogin()
java.lang.String	getMiddleName()
java.lang.String	getNickName()
java.lang.String	getNumber()
int	getObjectVersion()
Account	getOwner()
java.lang.String	getOwnerId()
java.util.Map	getPhones()
java.util.List	getPhoneTypes()
java.lang.String	getSalutation()
java.lang.String	getUrl()
java.util.Map	insertExtendedAttrs(java.lang.String key, java.lang.String val)
Job	insertJob(java.util.Date startDate, java.util.Date endDate, java.lang.String name)
Job	insertJob(Job job)
Phone	insertPhone(java.lang.String type, java.lang.String number, java.lang.String info)
boolean	isAccount()
boolean	isComplete()
boolean	isPrivate()
boolean	removePhone(Phone phone)
void	setBirthDate(java.util.Date birthdate)
void	setComment(java.lang.String comment)
void	setContact(Account account)
void	setFirstName(java.lang.String first_name)
void	setGender(java.lang.String gender)
void	setIsAccount(boolean bool)
void	setIsComplete(boolean bool)
void	setIsPrivate(boolean bool)
void	setKeywords(java.lang.String keywords)
void	setLastName(java.lang.String last_name)
void	setMiddleName(java.lang.String middle_name)
void	setNickName(java.lang.String nick_name)
void	setNumber(java.lang.String string)
void	setObjectVersion(int objectVersion)
void	setOwner(Account account)
void	setOwnerId(java.lang.String ownerId)
void	setSalutation(java.lang.String salutation)
void	setUrl(java.lang.String url)

Method Detail

getFirstName

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

Throws:

OgoException

ConnectionException

setFirstName

public void setFirstName(java.lang.String first_name)
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

insertExtendedAttrs

public java.util.Map insertExtendedAttrs(java.lang.String key,
                                         java.lang.String val)
                                  throws OgoException,
                                         ConnectionException

Throws:

OgoException

ConnectionException

fetch

public java.util.List fetch(FetchSpecification spec,
                            int type)
                     throws OgoException,
                            ConnectionException

Throws:

OgoException

ConnectionException

getEnterprises

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

Returns:

the Enterprises this Person record is associated with.

Throws:

OgoException

ConnectionException

fetchEnterprises

public java.util.List fetchEnterprises(FetchSpecification fspec)
                                throws OgoException,
                                       ConnectionException

Returns:

the Enterprises this Person record is associated with.

Throws:

OgoException

ConnectionException

getObjectVersion

public int getObjectVersion()
                     throws OgoException,
                            ConnectionException

Throws:

OgoException

ConnectionException

setObjectVersion

public void setObjectVersion(int objectVersion)
                      throws OgoException,
                             ConnectionException

Throws:

OgoException

ConnectionException

getComment

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

Throws:

OgoException

ConnectionException

setComment

public void setComment(java.lang.String comment)
                throws OgoException,
                       ConnectionException

Throws:

OgoException

ConnectionException

getLastName

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

Throws:

OgoException

ConnectionException

setLastName

public void setLastName(java.lang.String last_name)
                 throws OgoException,
                        ConnectionException

Throws:

OgoException

ConnectionException

getMiddleName

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

Throws:

OgoException

ConnectionException

setMiddleName

public void setMiddleName(java.lang.String middle_name)
                   throws OgoException,
                          ConnectionException

Throws:

OgoException

ConnectionException

getNickName

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

Throws:

OgoException

ConnectionException

setNickName

public void setNickName(java.lang.String nick_name)
                 throws OgoException,
                        ConnectionException

Throws:

OgoException

ConnectionException

getUrl

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

Throws:

OgoException

ConnectionException

setUrl

public void setUrl(java.lang.String url)
            throws OgoException,
                   ConnectionException

Throws:

OgoException

ConnectionException

getSalutation

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

Throws:

OgoException

ConnectionException

setSalutation

public void setSalutation(java.lang.String salutation)
                   throws OgoException,
                          ConnectionException

Throws:

OgoException

ConnectionException

getGender

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

Throws:

OgoException

ConnectionException

setGender

public void setGender(java.lang.String gender)
               throws OgoException,
                      ConnectionException

Throws:

OgoException

ConnectionException

getLogin

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

Throws:

OgoException

ConnectionException

getExtendedAttributs

public java.util.Map getExtendedAttributs()
                                   throws OgoException,
                                          ConnectionException

Throws:

OgoException

ConnectionException

getKeywords

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

Throws:

OgoException

ConnectionException

setKeywords

public void setKeywords(java.lang.String keywords)
                 throws OgoException,
                        ConnectionException

Throws:

OgoException

ConnectionException

getNumber

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

Throws:

OgoException

ConnectionException

setNumber

public void setNumber(java.lang.String string)
               throws OgoException,
                      ConnectionException

Throws:

OgoException

ConnectionException

setContact

public void setContact(Account account)
                throws OgoException,
                       ConnectionException

Parameters:

account -

Throws:

OgoException

ConnectionException

getContact

public Account getContact()
                   throws OgoException,
                          ConnectionException

Throws:

OgoException

ConnectionException

setOwner

public void setOwner(Account account)
              throws OgoException,
                     ConnectionException

Throws:

OgoException

ConnectionException

getOwner

public Account getOwner()
                 throws OgoException,
                        ConnectionException

Throws:

OgoException

ConnectionException

getOwnerId

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

Throws:

OgoException

ConnectionException

setOwnerId

public void setOwnerId(java.lang.String ownerId)
                throws OgoException,
                       ConnectionException

Throws:

OgoException

ConnectionException

getBirthdate

public java.util.Date getBirthdate()
                            throws OgoException,
                                   ConnectionException

Throws:

OgoException

ConnectionException

setBirthDate

public void setBirthDate(java.util.Date birthdate)
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

isAccount

public boolean isAccount()
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

isComplete

public boolean isComplete()
                   throws OgoException,
                          ConnectionException

Throws:

OgoException

ConnectionException

isPrivate

public boolean isPrivate()
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

setIsAccount

public void setIsAccount(boolean bool)
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

setIsComplete

public void setIsComplete(boolean bool)
                   throws OgoException,
                          ConnectionException

Throws:

OgoException

ConnectionException

setIsPrivate

public void setIsPrivate(boolean bool)
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

getPhoneTypes

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

Throws:

OgoException

ConnectionException

getId

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

Throws:

OgoException

ConnectionException

insertPhone

public Phone insertPhone(java.lang.String type,
                         java.lang.String number,
                         java.lang.String info)
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

removePhone

public boolean removePhone(Phone phone)
                    throws OgoException,
                           ConnectionException

Throws:

OgoException

ConnectionException

getAddresses

public java.util.Map getAddresses()
                           throws OgoException,
                                  ConnectionException

Returns a Map with several adresses assigned to this Person. The OpenGroupware.org XML-RPC documentation defines 3 default types of adresses: "location", "mailing", "private". If they are available they can be fetched from the Map with their names as key. There might be less or more different address objects in the Map.

Returns:

a Map containing Address objects for this Person object.

Throws:

OgoException

ConnectionException

getPhones

public java.util.Map getPhones()
                        throws OgoException,
                               ConnectionException

Throws:

OgoException

ConnectionException

deleteJob

public void deleteJob(Job job)
               throws OgoException,
                      ConnectionException

Throws:

OgoException

ConnectionException

deleteJob

public void deleteJob(java.lang.String id)
               throws OgoException,
                      ConnectionException

Throws:

OgoException

ConnectionException

deleteJobs

public void deleteJobs(java.util.List list)
                throws OgoException,
                       ConnectionException

Throws:

OgoException

ConnectionException

insertJob

public Job insertJob(java.util.Date startDate,
                     java.util.Date endDate,
                     java.lang.String name)
              throws OgoException,
                     ConnectionException

Throws:

OgoException

ConnectionException

fetchJobs

public java.util.List fetchJobs(FetchSpecification fspec)
                         throws OgoException,
                                ConnectionException

Throws:

OgoException

ConnectionException

insertJob

public Job insertJob(Job job)
              throws OgoException,
                     ConnectionException

Throws:

OgoException

ConnectionException

fetchJobsAsIds

public java.util.List fetchJobsAsIds(FetchSpecification fspec)
                              throws OgoException,
                                     ConnectionException

Throws:

OgoException

ConnectionException