com.atlassian.confluence.user
Class PersonalInformation

java.lang.Object
  extended by com.atlassian.core.bean.EntityObject
      extended by com.atlassian.confluence.core.ConfluenceEntityObject
          extended by com.atlassian.confluence.core.AbstractVersionedEntityObject
              extended by com.atlassian.confluence.core.ContentEntityObject
                  extended by com.atlassian.confluence.user.PersonalInformation
All Implemented Interfaces:
com.atlassian.bonnie.Searchable, Addressable, Versioned, Labelable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class PersonalInformation
extends ContentEntityObject

See Also:
Serialized Form

Field Summary
static java.lang.String CONTENT_TYPE
           
 
Fields inherited from class com.atlassian.confluence.core.ContentEntityObject
CREATED, CURRENT, DELETED, MODIFIED
 
Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject
INITIAL_VERSION
 
Constructor Summary
PersonalInformation()
           
PersonalInformation(com.atlassian.user.User user, UserAccessor userAccessor)
           
 
Method Summary
 boolean belongsTo(com.atlassian.user.User user)
          Returns true if this object belongs to the specified user.
 boolean equals(java.lang.Object o)
           
 java.util.List getBodyContents()
           
 java.lang.String getDisplayTitle()
          The title of the addressable object, suitable for display in a list
 java.lang.String getEmail()
           
 java.lang.String getFullName()
           
 java.lang.String getHasPersonalSpace()
           
 java.lang.String getNameForComparison()
          Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
 java.lang.String getType()
          An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
 java.lang.String getUrlPath()
           
 java.lang.String getUsername()
           
 int hashCode()
           
 boolean isIndexable()
          Content entity objects that are historical versions should not be indexed.
 void setEmail(java.lang.String email)
           
 void setFullName(java.lang.String fullName)
           
 void setUsername(java.lang.String username)
           
 java.lang.String toString()
          Override this method so we don't call getFullName() everytime toString is called on the object!
 
Methods inherited from class com.atlassian.confluence.core.ContentEntityObject
addAttachment, addLabelling, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, clone, compareTo, convertToHistoricalVersion, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getContent, getContentPermission, getContentPermissionSet, getContentStatus, getExcerpt, getGlobalLabels, getIdAsString, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getPersonalLabels, getRealTitle, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getUserAccessor, getVersionComment, getVisibleLabels, hasPermissions, isCurrent, isDeleted, isFavourite, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeContentPermissionSet, removeLabelling, removeOutgoingLink, removeReferralLink, removeTrackbackLink, setAttachments, setBodyContents, setContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTitle, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, trash
 
Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject
getLatestVersion, getOriginalVersion, getVersion, isLatestVersion, isNew, setOriginalVersion, setVersion
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject
getCreatorName, getLastModifierName, isPersistent, setCreatorName, setLastModifierName
 
Methods inherited from class com.atlassian.core.bean.EntityObject
getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.atlassian.bonnie.Searchable
getId
 
Methods inherited from interface com.atlassian.confluence.core.Addressable
getId
 

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE
See Also:
Constant Field Values
Constructor Detail

PersonalInformation

public PersonalInformation()

PersonalInformation

public PersonalInformation(com.atlassian.user.User user,
                           UserAccessor userAccessor)
Method Detail

toString

public java.lang.String toString()
Override this method so we don't call getFullName() everytime toString is called on the object!

Overrides:
toString in class ContentEntityObject
Returns:
a string representation of this personal information object

getDisplayTitle

public java.lang.String getDisplayTitle()
Description copied from interface: Addressable
The title of the addressable object, suitable for display in a list

Specified by:
getDisplayTitle in interface Addressable
Overrides:
getDisplayTitle in class ContentEntityObject
Returns:

getUrlPath

public java.lang.String getUrlPath()
Specified by:
getUrlPath in interface Addressable
Specified by:
getUrlPath in class ContentEntityObject

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getBodyContents

public java.util.List getBodyContents()
Overrides:
getBodyContents in class ContentEntityObject

belongsTo

public boolean belongsTo(com.atlassian.user.User user)
Returns true if this object belongs to the specified user.

Parameters:
user - the user to check
Returns:
true if the user owns this object, otherwise false
Since:
2.8

getFullName

public java.lang.String getFullName()

setFullName

public void setFullName(java.lang.String fullName)

getEmail

public java.lang.String getEmail()

setEmail

public void setEmail(java.lang.String email)

getType

public java.lang.String getType()
Description copied from class: ContentEntityObject
An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.

This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.

Specified by:
getType in interface Addressable
Specified by:
getType in class ContentEntityObject

hashCode

public int hashCode()
Overrides:
hashCode in class ContentEntityObject

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class ContentEntityObject

getNameForComparison

public java.lang.String getNameForComparison()
Description copied from class: ContentEntityObject
Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.

Specified by:
getNameForComparison in class ContentEntityObject

isIndexable

public boolean isIndexable()
Description copied from class: ContentEntityObject
Content entity objects that are historical versions should not be indexed.

Specified by:
isIndexable in interface com.atlassian.bonnie.Searchable
Overrides:
isIndexable in class ContentEntityObject

getHasPersonalSpace

public java.lang.String getHasPersonalSpace()


Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.