com.alogient.cameleon.sdk.content.dao.model.Nav 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.dao.model;

import javax.persistence.Basic;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import java.io.Serializable;
import java.util.Set;
import javax.persistence.OrderBy;

/**
 * The navigation is used to organise the pages into a tree structure. One must be carefull not to mistake this navigation into the
 * structure for a menu. Altho it can be used as a menu, it is not the recommanded best practice.
 * 
 * @author alord
 */
@Entity
@Table(name = "Nav")
public class Nav implements Serializable {
    /**
     * Serial version unique identifier
     */
    private static final long serialVersionUID = -3621096640068284425L;

    /**
     * The primary key for this object
     */
    private Integer navId;

    /**
     * FIXME Add foreign key and element 0, make nullable
     * The parent of this navigation item
     */
    private Nav parent;

    /**
     * The children of this navigation item
     */
    private Set childrenNav;

    /**
     * The template associated with this navigation item
     */
    private Template template;

    /**
     * The ordering of this navigation item
     */
    private Integer navOrder;

    /**
     * Does this naviagtion
     */
    private Boolean inheritPermissions;

    /**
     * The pages of this navigation item
     */
    private Set pages;

    /**
     * @return the navId
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "NavID", nullable = false)
    public Integer getNavId() {
        return navId;
    }

    /**
     * @param navId
     *            the navId to set
     */
    public void setNavId(Integer navId) {
        this.navId = navId;
    }

    /**
     * @return the parent
     */
    @ManyToOne(fetch = FetchType.LAZY, optional = true, cascade = CascadeType.ALL)
    @JoinColumn(name = "ParentID")
    public Nav getParent() {
        return parent;
    }

    /**
     * @param parent
     *            the parent to set
     */
    public void setParent(Nav parent) {
        this.parent = parent;
    }

    /**
     * @return the childrenNav
     */
    @OneToMany(fetch = FetchType.LAZY, mappedBy = "parent", cascade = CascadeType.ALL)
    @OrderBy("navOrder ASC")
    public Set getChildrenNav() {
        return childrenNav;
    }

    /**
     * @param childrenNav
     *            the childrenNav to set
     */
    public void setChildrenNav(Set childrenNav) {
        this.childrenNav = childrenNav;
    }

    /**
     * @return the template
     */
    @ManyToOne(fetch = FetchType.LAZY, optional = false, cascade = CascadeType.ALL)
    @JoinColumn(name = "TemplateID")
    public Template getTemplate() {
        return template;
    }

    /**
     * @param template
     *            the template to set
     */
    public void setTemplate(Template template) {
        this.template = template;
    }

    /**
     * @return the navOrder
     */
    @Column(name="NavOrder", nullable = false)
    @Basic(optional=false)
    public Integer getNavOrder() {
        return navOrder;
    }

    /**
     * @param navOrder
     *            the navOrder to set
     */
    public void setNavOrder(Integer navOrder) {
        this.navOrder = navOrder;
    }

    /**
     * @return the inheritPermissions
     */
    @Column(name="InheritPermissions", nullable = false)
    @Basic(optional=false)
    public Boolean getInheritPermissions() {
        return inheritPermissions;
    }

    /**
     * @param inheritPermissions
     *            the inheritPermissions to set
     */
    public void setInheritPermissions(Boolean inheritPermissions) {
        this.inheritPermissions = inheritPermissions;
    }

    /**
     * @return the pages
     */
    @OneToMany(fetch = FetchType.LAZY, mappedBy = "nav", cascade = CascadeType.ALL)
    public Set getPages() {
        return pages;
    }

    /**
     * @param pages the pages to set
     */
    public void setPages(Set pages) {
        this.pages = pages;
    }
}