org.gxos.schema
Class UserObject

java.lang.Object
  |
  +--org.gxos.schema.TreeObject
        |
        +--org.gxos.schema.UserObject
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
User, UserGroup

public abstract class UserObject
extends TreeObject
implements java.io.Serializable

GXOS user class. It can use multiple personal information schemas. At the time, Virtual Classroom, IMS and PAPI types are supported.

See Also:
Serialized Form

Constructor Summary
UserObject()
           
 
Method Summary
 void addComments(java.lang.String vComments)
           
 java.util.Enumeration enumerateComments()
           
 java.lang.String[] getComments()
           
 java.lang.String getComments(int index)
           
 int getCommentsCount()
           
 ImsPersonalInfo getImsPersonalInfo()
           
 PapiPersonalInfo getPapiPersonalInfo()
           
 PersonalInfoTypeType getPersonalInfoType()
           
 Preferences getPreferences()
           
 Relations getRelations()
           
 Security getSecurity()
           
 VCPersonalInfo getVCPersonalInfo()
           
 boolean isValid()
           
abstract  void marshal(org.xml.sax.DocumentHandler handler)
           
abstract  void marshal(java.io.Writer out)
           
 void removeAllComments()
           
 java.lang.String removeComments(int index)
           
 void setComments(java.lang.String[] commentsArray)
           
 void setComments(java.lang.String vComments, int index)
           
 void setImsPersonalInfo(ImsPersonalInfo _imsPersonalInfo)
           
 void setPapiPersonalInfo(PapiPersonalInfo _papiPersonalInfo)
           
 void setPersonalInfoType(PersonalInfoTypeType _personalInfoType)
           
 void setPreferences(Preferences _preferences)
           
 void setRelations(Relations _relations)
           
 void setSecurity(Security _security)
           
 void setVCPersonalInfo(VCPersonalInfo _vCPersonalInfo)
           
 void validate()
           
 
Methods inherited from class org.gxos.schema.TreeObject
addCustomExtension, addNodeComment, enumerateCustomExtension, enumerateNodeComment, getCustomExtension, getCustomExtension, getCustomExtensionCount, getCustomType, getExtensions, getHistoryObject, getNodeChildren, getNodeComment, getNodeComment, getNodeCommentCount, getNodeContents, getNodeEndTime, getNodeName, getNodeProfile, getNodeRooting, getNodeStartTime, getNodeType, getNodeUpdateTime, getNodeVersionNumber, getParentObject, removeAllCustomExtension, removeAllNodeComment, removeCustomExtension, removeNodeComment, setCustomExtension, setCustomExtension, setCustomType, setExtensions, setHistoryObject, setNodeChildren, setNodeComment, setNodeComment, setNodeContents, setNodeEndTime, setNodeName, setNodeProfile, setNodeRooting, setNodeStartTime, setNodeType, setNodeUpdateTime, setNodeVersionNumber, setParentObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserObject

public UserObject()
Method Detail

addComments

public void addComments(java.lang.String vComments)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vComments -  

enumerateComments

public java.util.Enumeration enumerateComments()

getComments

public java.lang.String getComments(int index)
                             throws java.lang.IndexOutOfBoundsException
Parameters:
index -  

getComments

public java.lang.String[] getComments()

getCommentsCount

public int getCommentsCount()

getImsPersonalInfo

public ImsPersonalInfo getImsPersonalInfo()

getPapiPersonalInfo

public PapiPersonalInfo getPapiPersonalInfo()

getPersonalInfoType

public PersonalInfoTypeType getPersonalInfoType()

getPreferences

public Preferences getPreferences()

getRelations

public Relations getRelations()

getSecurity

public Security getSecurity()

getVCPersonalInfo

public VCPersonalInfo getVCPersonalInfo()

isValid

public boolean isValid()
Overrides:
isValid in class TreeObject

marshal

public abstract void marshal(java.io.Writer out)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException
Overrides:
marshal in class TreeObject
Parameters:
out -  

marshal

public abstract void marshal(org.xml.sax.DocumentHandler handler)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException
Overrides:
marshal in class TreeObject
Parameters:
handler -  

removeAllComments

public void removeAllComments()

removeComments

public java.lang.String removeComments(int index)
Parameters:
index -  

setComments

public void setComments(java.lang.String vComments,
                        int index)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vComments -  
index -  

setComments

public void setComments(java.lang.String[] commentsArray)
Parameters:
commentsArray -  

setImsPersonalInfo

public void setImsPersonalInfo(ImsPersonalInfo _imsPersonalInfo)
Parameters:
_imsPersonalInfo -  

setPapiPersonalInfo

public void setPapiPersonalInfo(PapiPersonalInfo _papiPersonalInfo)
Parameters:
_papiPersonalInfo -  

setPersonalInfoType

public void setPersonalInfoType(PersonalInfoTypeType _personalInfoType)
Parameters:
_personalInfoType -  

setPreferences

public void setPreferences(Preferences _preferences)
Parameters:
_preferences -  

setRelations

public void setRelations(Relations _relations)
Parameters:
_relations -  

setSecurity

public void setSecurity(Security _security)
Parameters:
_security -  

setVCPersonalInfo

public void setVCPersonalInfo(VCPersonalInfo _vCPersonalInfo)
Parameters:
_vCPersonalInfo -  

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Overrides:
validate in class TreeObject