org.alfresco.service.cmr.publishing.channels

Interface Channel

All Known Implementing Classes:

ChannelImpl

public interface Channel

Represents a publishing channel

Since:

4.0

Author:

Brian, Nick Smith

Method Summary

Modifier and Type	Method and Description
boolean	canPublish() Returns true only if the currently authenticated user can publish content to this Channel.
boolean	canPublishStatusUpdates() Returns true only if the currently authenticated user can unpublish status updates to this Channel.
boolean	canUnpublish() Returns true only if the currently authenticated user can unpublish content from this Channel.
ChannelType	getChannelType()
String	getId()
String	getName() Retrieve the name of this channel
org.alfresco.service.cmr.repository.NodeRef	getNodeRef() Retrieve the node ref of the node that represents this channel object in the repository
Map<org.alfresco.service.namespace.QName,Serializable>	getProperties() Retrieve the properties defined on this channel.
String	getUrl(org.alfresco.service.cmr.repository.NodeRef publishedNode) Returns the URL for the specified node on this channel.
boolean	isAuthorised() Has this channel been authorised yet? Typically, when a channel is created in Alfresco the user is sent to the service provider to authorise Alfresco to access their account on their behalf.
void	sendStatusUpdate(String status, String urlToAppend) Post the specified text onto this channel as a status update.

Method Detail

getId

String getId()

Returns:

a unique identifier for this Channel.

getChannelType

ChannelType getChannelType()

Returns:

the ChannelType for this Channel.

getNodeRef

org.alfresco.service.cmr.repository.NodeRef getNodeRef()

Retrieve the node ref of the node that represents this channel object in the repository

Returns:

NodeRef

getName

String getName()

Retrieve the name of this channel

Returns:

String

getProperties

Map<org.alfresco.service.namespace.QName,Serializable> getProperties()

Retrieve the properties defined on this channel.

Returns:

Map

sendStatusUpdate

void sendStatusUpdate(String status,
                      String urlToAppend)

Post the specified text onto this channel as a status update.

Parameters:

status - The text of the status update. Note that if the length of this text plus the length of the urlToAppend text is greater than the maximum length permitted as a status update on this channel then this text will be truncated to fit.

urlToAppend - Text that is to be appended to the status update - often a URL to a relevant piece of content. If this channel can't accept both the status text and the URL then the status text will be truncated in preference to the URL. This argument may be null.

getUrl

String getUrl(org.alfresco.service.cmr.repository.NodeRef publishedNode)

Returns the URL for the specified node on this channel.

Parameters:

publishedNode - The content node whose published URL is being requested.

Returns:

a URL for the published content. May return null if the specified node has not been published to this channel.

isAuthorised

boolean isAuthorised()

Has this channel been authorised yet? Typically, when a channel is created in Alfresco the user is sent to the service provider to authorise Alfresco to access their account on their behalf. Once Alfresco has been told that the user has done that then this operation will return true. Until then, this operation will return false. A channel that is not authorised cannot be used to publish content or status updates to.

Returns:

true if this channel has been authorised and is ready for use.

canPublish

boolean canPublish()

Returns true only if the currently authenticated user can publish content to this Channel. If the ChannelType does not support publishing, if the Channel is not authorised or if the currently authenticated user does not have permission to publish to this Channel then this method will return false.

Returns:

boolean

canUnpublish

boolean canUnpublish()

Returns true only if the currently authenticated user can unpublish content from this Channel. If the ChannelType does not support unpublishing, if the Channel is not authorised or if the currently authenticated user does not have permission to publish to this Channel then this method will return false.

Returns:

boolean

canPublishStatusUpdates

boolean canPublishStatusUpdates()

Returns true only if the currently authenticated user can unpublish status updates to this Channel. If the ChannelType does not support publishing of status updates, if the Channel is not authorised or if the currently authenticated user does not have permission to publish to this Channel then this method will return false.

Returns:

boolean