org.alfresco.service.cmr.publishing.channels
Interface ChannelService

All Known Implementing Classes:

ChannelServiceImpl

public interface ChannelService

Since:

4.0

Method Summary

Channel	createChannel(java.lang.String channelTypeId, java.lang.String name, java.util.Map properties) Create a new channel of the specified channel type on the specified Share site with the specified name and properties.
void	deleteChannel(Channel channel) Remove the specified channel.
Channel	getChannelById(java.lang.String id) Retrieve the channel with the given id.
Channel	getChannelByName(java.lang.String channelName) Retrieve the channel with the given channel name.
java.util.List	getChannels() Retrieve all the channels.
ChannelType	getChannelType(java.lang.String id) Retrieve the channel type that has the specified identifier
java.util.List	getChannelTypes() Retrieve all the registered channel types
java.util.List	getPublishingChannels(boolean filterByPublishPermission) Returns a list of all the channels that are capable of publishing in the specified Share site.
java.util.List	getRelevantPublishingChannels(org.alfresco.service.cmr.repository.NodeRef nodeToPublish) Returns a list of all the channels that are capable of publishing the specified NodeRef.
java.util.List	getStatusUpdateChannels(boolean filterByPublishPermission) Returns all Channels cpaable of performing a status update for the given Share Site.
void	register(AbstractChannelType channelType) Register a new channel type with the channel service
void	renameChannel(Channel channel, java.lang.String newName) Rename the specified channel
void	updateChannel(Channel channel, java.util.Map properties) Update the properties of the specified channel.

Method Detail

register

@NotAuditable
void register(AbstractChannelType channelType)

Register a new channel type with the channel service

Parameters:

channelType - The channel type to be registered.

Throws:

java.lang.IllegalArgumentException - if a channel type is already registered that has the same identifier as the supplied one

getChannelType

@NotAuditable
ChannelType getChannelType(java.lang.String id)

Retrieve the channel type that has the specified identifier

Parameters:

id - The identifier of the channel type to be retrieved

Returns:

A ChannelType object that represents the channel type with the specified identifier

getChannelTypes

@NotAuditable
java.util.List getChannelTypes()

Retrieve all the registered channel types

Returns:

A list of ChannelType objects, each representing a channel type registered with this channel service

createChannel

@Auditable(parameters={"channelTypeId", "name"})
Channel createChannel(java.lang.String channelTypeId,
                                java.lang.String name,
                                java.util.Map properties)

Create a new channel of the specified channel type on the specified Share site with the specified name and properties.

Parameters:

channelTypeId - The identifier of the channel type that is to be used for the new channel. This must identify a channel type that has been registered with the channel service.

name - The name of the new channel. This must be unique within the specified Share site.

properties - Any additional properties that are to be saved as part of the new channel.

Returns:

A Channel object corresponding to the newly created channel.

deleteChannel

@Auditable
void deleteChannel(Channel channel)

Remove the specified channel.

Parameters:

channel - The channel to delete.

renameChannel

@Auditable(parameters="newName")
void renameChannel(Channel channel,
                             java.lang.String newName)

Rename the specified channel

Parameters:

channel - The channel that is to be renamed.

newName - The new name of the channel

updateChannel

@Auditable
void updateChannel(Channel channel,
                             java.util.Map properties)

Update the properties of the specified channel.

Parameters:

channel - The channel that is to be updated.

properties - The properties to set on the channel. These are blended with the current properties on the channel. Any that aren't currently set will be added, others will be updated.

getChannels

@NotAuditable
java.util.List getChannels()

Retrieve all the channels.

Returns:

A list of Channel objects, each one representing a channel that exists within the specified Share site.

getChannelByName

@NotAuditable
Channel getChannelByName(java.lang.String channelName)

Retrieve the channel with the given channel name.

Parameters:

channelName - The name of the channel

Returns:

The specified Channel objects or null if the specified channel does not exist.

getChannelById

@NotAuditable
Channel getChannelById(java.lang.String id)

Retrieve the channel with the given id.

Parameters:

id - The string value of the channel NodeRef.

Returns:

The specified Channel objects or null if the specified channel does not exist.

getRelevantPublishingChannels

@NotAuditable
java.util.List getRelevantPublishingChannels(org.alfresco.service.cmr.repository.NodeRef nodeToPublish)

Returns a list of all the channels that are capable of publishing the specified NodeRef.

Parameters:

nodeToPublish -

Returns:

getPublishingChannels

@NotAuditable
java.util.List getPublishingChannels(boolean filterByPublishPermission)

Returns a list of all the channels that are capable of publishing in the specified Share site.

Parameters:

filterByPublishPermission - If true then the returned channels are filtered to include only those to which the authenticated user can publish

Returns:

getStatusUpdateChannels

@NotAuditable
java.util.List getStatusUpdateChannels(boolean filterByPublishPermission)

Returns all Channels cpaable of performing a status update for the given Share Site.

Parameters:

filterByPublishPermission - If true then the returned channels are filtered to include only those to which the authenticated user can post status updates

Returns: