public interface ProjectLink extends Adaptable
ProjectManager
for details.Modifier and Type | Method and Description |
---|---|
Resource |
getCoverImage()
Returns the resource representing the project's cover image.
|
String |
getDescription()
Returns the description of the link.
|
Project |
getProject()
Returns the project that this link is associated with.
|
String |
getResolvedTitle()
Returns the title of the target of this link if no title was set on this link.
|
String |
getTarget()
Returns the target path or url of this link.
|
String |
getTitle()
Returns the title of the link.
|
void |
setCoverImage(String mimeType,
InputStream stream)
Associate a new image to this link's cover.
|
void |
setDescription(String description)
Set a new description for the link.
|
void |
setTarget(String target)
Set the target path or url for this link.
|
void |
setTitle(String title)
Set a new title for the link.
|
Project getProject()
String getTarget()
void setTarget(String target)
target
- the target path or url for this linkString getTitle()
void setTitle(String title)
title
- the new name for the linkProjectException
- if the operation failsString getResolvedTitle()
setTitle(java.lang.String)
then that title will be returned,
otherwise the title of the target resource will be returned.
E.g. If the link points to a cq:Page the page's title will be returned,
similarly if the link points to an Asset the asset's title will be returned.String getDescription()
void setDescription(String description)
description
- the new description for the linkProjectException
- if the operation failsvoid setCoverImage(String mimeType, InputStream stream)
mimeType
- the mime type of the provided input streamstream
- a stream of image data.ProjectException
- if updating the cover image fails.Resource getCoverImage()
Copyright © 2010 - 2020 Adobe. All Rights Reserved