io.sphere.sdk.channels.Channel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sphere-models Show documentation

sphere-models

There is a newer version: 1.0.0-M26

package io.sphere.sdk.channels;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.models.LocalizedString;
import io.sphere.sdk.models.Resource;
import io.sphere.sdk.models.Reference;

import javax.annotation.Nullable;
import java.util.Set;

/** Channels represent a source or destination of different entities.

    Operations:
    
        Create a channel with {@link io.sphere.sdk.channels.commands.ChannelCreateCommand}.
        Query a channel with {@link io.sphere.sdk.channels.queries.ChannelQuery}.
        Delete a channel with {@link io.sphere.sdk.channels.commands.ChannelDeleteCommand}.
    
 */
@JsonDeserialize(as = ChannelImpl.class)
public interface Channel extends Resource {
    String getKey();

    Set getRoles();

    @Nullable
    LocalizedString getName();

    @Nullable
    LocalizedString getDescription();


    default Reference toReference() {
        return Reference.of(referenceTypeId(), getId(), this);
    }

    static String referenceTypeId(){
        return "channel";
    }

    /**
     *
     * @deprecated use {@link #referenceTypeId()} instead
     * @return referenceTypeId
     */
    @Deprecated
    static String typeId(){
        return "channel";
    }

    static TypeReference typeReference(){
        return new TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }
}