Interface FeedBlock
-
- All Superinterfaces:
BaseAsset
,Block
,FolderContainedAsset
,MetadataAwareAsset
,NamedAsset
,PermissionsCapableAsset
public interface FeedBlock extends Block
Represents a Feed Block asset.- Since:
- 4.7
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getFeed()
org.jdom.Element
getFeedAsXMLElement()
Fetches the feed from the URL as XML element instead of String.java.lang.String
getFeedURL()
Get the URL of the XML feed this block will aggregate.void
setFeedURL(java.lang.String feedURL)
Set the URL of the XML feed this block will aggregate.-
Methods inherited from interface com.hannonhill.cascade.api.asset.common.BaseAsset
getAssetId, getAssetType, getIdentifer
-
Methods inherited from interface com.hannonhill.cascade.api.asset.home.Block
getBlockType
-
Methods inherited from interface com.hannonhill.cascade.api.asset.home.FolderContainedAsset
getCreatedBy, getCreatedOn, getFolderOrder, getIdentifier, getLastModified, getLastModifiedBy, getParentFolder, getParentFolderIdentifier, getPath, getSite, getSiteId, getSiteName, getTags, isHideSystemName, setHideSystemName, setParentFolder, setParentFolderIdentifier
-
Methods inherited from interface com.hannonhill.cascade.api.asset.home.MetadataAwareAsset
getLabel, getLinkingAssets, getMetadata, getMetadataSet, getMetadataSetId
-
Methods inherited from interface com.hannonhill.cascade.api.asset.common.NamedAsset
getName, setName
-
Methods inherited from interface com.hannonhill.cascade.api.asset.common.PermissionsCapableAsset
isCurrentUserCanRead, isCurrentUserCanWrite, isUserCanRead, isUserCanWrite
-
-
-
-
Method Detail
-
getFeedURL
java.lang.String getFeedURL()
Get the URL of the XML feed this block will aggregate.- Returns:
- the URL of the XML feed this block aggregates
-
setFeedURL
void setFeedURL(java.lang.String feedURL)
Set the URL of the XML feed this block will aggregate.- Parameters:
feedURL
- the URL of an XML feed
-
getFeed
java.lang.String getFeed()
- Returns:
- Fetches the feed from the URL. Will return null if feedURL is empty or it can't connect to given URL. Returns null if the fetched contents were not valid XML. Will strip any XML declarations, doctypes etc.
-
getFeedAsXMLElement
org.jdom.Element getFeedAsXMLElement() throws java.lang.Exception
Fetches the feed from the URL as XML element instead of String. The returned Element will always be system-xml element containing the actual XML as its children.- Returns:
- Throws:
java.lang.Exception
-
-