public interface ChannelService
| Modifier and Type | Method and Description |
|---|---|
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.
|
@NotAuditable void register(AbstractChannelType channelType)
channelType - The channel type to be registered.java.lang.IllegalArgumentException - if a channel type is already registered that has the same identifier as the supplied one@NotAuditable ChannelType getChannelType(java.lang.String id)
id - The identifier of the channel type to be retrieved@NotAuditable java.util.List getChannelTypes()
@Auditable(parameters={"channelTypeId", "name"})
Channel createChannel(java.lang.String channelTypeId,
java.lang.String name,
java.util.Map properties)
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.@Auditable void deleteChannel(Channel channel)
channel - The channel to delete.@Auditable(parameters="newName") void renameChannel(Channel channel, java.lang.String newName)
channel - The channel that is to be renamed.newName - The new name of the channel@Auditable void updateChannel(Channel channel, java.util.Map properties)
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.@NotAuditable java.util.List getChannels()
@NotAuditable Channel getChannelByName(java.lang.String channelName)
channelName - The name of the channelnull if the specified channel does not exist.@NotAuditable Channel getChannelById(java.lang.String id)
id - The string value of the channel NodeRef.null if the specified channel does not exist.@NotAuditable java.util.List getRelevantPublishingChannels(org.alfresco.service.cmr.repository.NodeRef nodeToPublish)
nodeToPublish - @NotAuditable java.util.List getPublishingChannels(boolean filterByPublishPermission)
filterByPublishPermission - If true then the returned channels are filtered to include only those
to which the authenticated user can publish@NotAuditable java.util.List getStatusUpdateChannels(boolean filterByPublishPermission)
Channels cpaable of performing a status update for the given Share Site.filterByPublishPermission - If true then the returned channels are filtered to include only those
to which the authenticated user can post status updatesCopyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.