SimplePageItem.java

/**********************************************************************************
 * $URL: $
 * $Id: $
 ***********************************************************************************
 *
 * Author: Eric Jeney, jeney@rutgers.edu
 *
 * Copyright (c) 2010 Rutgers, the State University of New Jersey
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");                                                                
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.opensource.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **********************************************************************************/

package org.sakaiproject.lessonbuildertool;

import java.util.Collection;

/**
 * This is a single item on a simple page.
 * 
 * @author jeney
 * 
 */
public interface SimplePageItem {

	public static final int RESOURCE = 1;
	public static final int PAGE = 2;
	public static final int ASSIGNMENT = 3;
	public static final int ASSESSMENT = 4;
	public static final int TEXT = 5;
	public static final int URL = 6;
	public static final int MULTIMEDIA = 7;
	public static final int FORUM = 8;
	public static final int COMMENTS = 9;
	public static final int STUDENT_CONTENT = 10;
	public static final int QUESTION = 11;
    public static final int BLTI = 12;
    public static final int PEEREVAL = 13;

    // sakaiId used for an item copied from another site with no real content
	public static final String DUMMY = "/dummy";


    /* WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. 
       If you change this, make very sure you change the archive and restore code in LessonBuilderEntityProducer
       and the copy code here.  Also copyItem in SimplePageBean.
       WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. WARNING. */

    public long getId();

    public long getPageId();

    public int getSequence();

    public int getType();

    public String getSakaiId();

    public String getName();

    public String getHtml();

    public String getDescription();

    public void setId(long i);

    public void setPageId(long s);

    public void setSequence(int o);

    public void setType(int t);

    public void setSakaiId(String s);

    public void setName(String s);

    public void setHtml(String html);

    public void setDescription(String desc);

    public void setHeight(String height);

    public String getHeight();

    public void setWidth(String width);

    public String getWidth();

    public void setAlt(String alt);

    public String getAlt();

    public void setNextPage(Boolean n);

    public boolean getNextPage();

    public void setFormat(String f);

    public String getFormat();

    public void setRequired(boolean required);

    public boolean isRequired();

    public void setAlternate(boolean alternate);

    public boolean isAlternate();

    public void setPrerequisite(boolean prerequisite);

	/**
	 * 
	 * @return Whether or not this is unavailable until all previous requirements are fulfilled.
	 */
    public boolean isPrerequisite();

    public void setSubrequirement(boolean requirement);

    public boolean getSubrequirement();

    public void setRequirementText(String requirementText);

    public String getRequirementText();

    public void setSameWindow(Boolean b);

    public Boolean isSameWindow();

    public String getURL();

    public String getItemURL(String siteId, String owner);
    
    public void setAnonymous(Boolean anon);
    
    public boolean isAnonymous();

    public void setGroups(String groups);

    public String getGroups();
    
    public void setShowComments(Boolean showComments);
    
    public Boolean getShowComments();
    
    public void setForcedCommentsAnonymous(Boolean forcedCommentsAnonymous);
    
    public boolean getForcedCommentsAnonymous();
    
    public void setGradebookId(String gradebookId);
    
    public String getGradebookId();
    
    public void setGradebookPoints(Integer points);
    
    public Integer getGradebookPoints();
    
    public void setGradebookTitle(String gradebookTitle);
    
    public String getGradebookTitle();
    
    public void setAltGradebook(String gradebookId);
    
    public String getAltGradebook();
    
    public void setAltPoints(Integer points);
    
    public Integer getAltPoints();

    public void setAltGradebookTitle(String gradebookTitle);
    
    public String getAltGradebookTitle();

    public boolean isGroupOwned();

    public void setGroupOwned(Boolean o);

    public String getOwnerGroups();

    public void setOwnerGroups(String s);
    
    public String getAttribute(String attr);
    
    public void setAttribute(String attr, String value);

    public Object getJsonAttribute(String attr);
    
    public void setJsonAttribute(String attr, Object value);

    public String getAttributeString();

    public void setAttributeString(String s);
    
    public void setShowPeerEval(Boolean review);
	
    public Boolean getShowPeerEval();
 
}