senselogic.sitevision.api.message

Interface ChannelUtil

@Requireable(value="ChannelUtil")
public interface ChannelUtil

Channel utility interface.

An instance of the Sitevision class implementing this interface can be obtained via MessagesFactory.getChannelUtil(). See MessagesFactory for how to obtain an instance of the MessagesFactory interface.

Since:

Sitevision 2024.05.1

Author:

Elias Abrache

Method Summary

Modifier and Type	Method and Description
Node	createChannel(String aName, String aDescription, boolean aPrivate) Creates a channel.
Node	findChannelByName(String aChannelName) Searches for a channel by name.

Method Detail

createChannel

Node createChannel(String aName,
                   String aDescription,
                   boolean aPrivate)
            throws RepositoryException

Creates a channel.

A ConstraintViolationException will be thrown if social collaboration is not enabled Or if current user is attempting to create a private channel without PermissionUtil.Permission.CREATE_PRIVATE_CHANNELS permission.

A IllegalArgumentException will be thrown if aName is null, blank or exceeds 80 characters.

A ItemExistsException will be thrown if a channel with the same name already exists.

A RepositoryException will be thrown If an error occurs while fetching channels

Parameters:

aName - the name of the channel (Must be unique and must not exceed 80 characters)

aDescription - the description of the channel

aPrivate - whether the channel should be private or not

Returns:

a channel wrapper for the newly created channel, or null.

Throws:

RepositoryException - if an error occurs.

findChannelByName

Node findChannelByName(String aChannelName)
                throws RepositoryException

Searches for a channel by name.

Permission note Private channels can only be found by members.

A ConstraintViolationException will be thrown if social collaboration is not enabled.

A RepositoryException will be thrown if an error occurs while fetching channels.

Parameters:

aChannelName - the name of the channel to search for.

Returns:

the channel node, or null.

Throws:

RepositoryException - if an error occurs.