com.alogient.cameleon.sdk.content.ui.injection.CameleonModelElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cameleon4java-sdk Show documentation

The newest version!

package com.alogient.cameleon.sdk.content.ui.injection;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used in a CameleonModel to map an element to a property.
 * 
 * @author alord
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface CameleonModelElement {
    public enum DataType {
        @Deprecated PartId, Value, OptionValue, @Deprecated File, Form, Video
    }

    /**
     * @return the name of the element
     */
    String elementName();

    /**
     * @return the data type of this element
     */
    DataType dataType();

    /**
     * @return should this field (and children) be indexed (true by default)
     */
    boolean isIndexed() default true;

    /**
     * @return the index field of the value (for value data type)
     */
    String valueIndexField() default "";

    /**
     * @return the index field of the video title (for video data type)
     */
    String videoTitleIndexField() default "";

    /**
     * @return the index field of the video description (for video data type)
     */
    String videoDescriptionIndexField() default "";
}