com.atlassian.confluence.user
Class PersonalInformation
java.lang.Object
com.atlassian.core.bean.EntityObject
com.atlassian.confluence.core.ConfluenceEntityObject
com.atlassian.confluence.core.AbstractVersionedEntityObject
com.atlassian.confluence.core.AbstractLabelableEntityObject
com.atlassian.confluence.core.ContentEntityObject
com.atlassian.confluence.user.PersonalInformation
- All Implemented Interfaces:
- com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, HasLinkWikiMarkup, Versioned, EditableLabelable, Labelable, Serializable, Cloneable, Comparable
public class PersonalInformation
- extends ContentEntityObject
- implements HasLinkWikiMarkup
- See Also:
- Serialized Form
Methods inherited from class com.atlassian.confluence.core.ContentEntityObject |
addAttachment, addComment, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, clone, compareTo, convertToHistoricalVersion, ensureAttachmentBelongsToContent, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getComments, getContentPermission, getContentPermissionSet, getContentStatus, getEntity, getExcerpt, getIdAsString, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getTypeEnum, getUserAccessor, getVersionComment, hasContentPermissions, hasPermissions, isCurrent, isDeleted, isIndexable, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeOutgoingLink, removeReferralLink, removeTrackbackLink, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setComments, setContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTitle, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, trash |
Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject |
addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, removeLabelling, setLabellings |
Methods inherited from class com.atlassian.core.bean.EntityObject |
getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate |
Methods inherited from interface com.atlassian.bonnie.Searchable |
getId |
Methods inherited from interface com.atlassian.confluence.core.Addressable |
getId |
CONTENT_TYPE
public static final String CONTENT_TYPE
- See Also:
- Constant Field Values
PersonalInformation
public PersonalInformation()
PersonalInformation
public PersonalInformation(com.atlassian.user.User user,
UserAccessor userAccessor)
getContentEntityObject
public ContentEntityObject getContentEntityObject()
toString
public 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 String getDisplayTitle()
- Description copied from class:
ContentEntityObject
- Returns the display title. Some entities don't have titles for identification. For example, personal information objects use the user's fullname.
Override this method to provide a custom title.
- Specified by:
getDisplayTitle
in interface Addressable
- Overrides:
getDisplayTitle
in class ContentEntityObject
- Returns:
- the display title
getUrlPath
public String getUrlPath()
- Specified by:
getUrlPath
in interface Addressable
- Specified by:
getUrlPath
in class ContentEntityObject
getAttachmentUrlPath
public String getAttachmentUrlPath(Attachment attachment)
- Description copied from class:
ContentEntityObject
- Gets the path relative to Confluence's base URL to view the given attachment in the context of this content
(for example, highlighted in the content's list of attachments). Generally you will want to call
Attachment.getUrlPath()
instead of this method: if we ever implement
view pages for individual attachments, that's the method that will be changed to point to them.
The default implementation just returns the view page for this content.
- Overrides:
getAttachmentUrlPath
in class ContentEntityObject
- Parameters:
attachment
- one of this content's attachments
- Returns:
- the path relative to the base url to view the attachment in the context of this content.
getUsername
public String getUsername()
setUsername
public void setUsername(String username)
getDefaultBodyType
public BodyType getDefaultBodyType()
- Overrides:
getDefaultBodyType
in class ContentEntityObject
getBodyContents
public List<BodyContent> 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 String getFullName()
setFullName
public void setFullName(String fullName)
getEmail
public String getEmail()
setEmail
public void setEmail(String email)
getType
public 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 ContentTypeAware
- Specified by:
getType
in class ContentEntityObject
- Returns:
- the content type
hashCode
public int hashCode()
- Overrides:
hashCode
in class ContentEntityObject
equals
public boolean equals(Object o)
- Overrides:
equals
in class ContentEntityObject
getNameForComparison
public 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
getHasPersonalSpace
public String getHasPersonalSpace()
getLinkWikiMarkup
public String getLinkWikiMarkup()
- Specified by:
getLinkWikiMarkup
in interface HasLinkWikiMarkup
- Returns:
- the wiki markup used to link to this content
Copyright © 2003-2012 Atlassian. All Rights Reserved.