001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/sam/trunk/component/src/java/org/sakaiproject/tool/assessment/business/questionpool/QuestionPool.java $
003: * $Id: QuestionPool.java 9273 2006-05-10 22:34:28Z daisyf@stanford.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the"License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.tool.assessment.business.questionpool;
021:
022: import java.io.Serializable;
023:
024: import org.osid.shared.Id;
025: import org.osid.shared.Type;
026:
027: /**
028: * This interface provides common methods for accessing a question pool.
029: * A question pool is defined as a centralized repository where questions
030: * are stored. They allow one to use the same question on multiple
031: * tests without duplicating data, and provide an assessment-independent
032: * way to store questions. This interface is based on the OKI standards,
033: * in the hopes it will be adopted as part of the assessment package.
034: *
035: * @author Rachel Gollub <rgollub@stanford.edu>
036: */
037: public interface QuestionPool extends Serializable {
038: /**
039: * DOCUMENTATION PENDING
040: *
041: * @param displayName DOCUMENTATION PENDING
042: *
043: * @throws QuestionPoolException DOCUMENTATION PENDING
044: */
045: void updateDisplayName(String displayName)
046: throws QuestionPoolException;
047:
048: /**
049: * DOCUMENTATION PENDING
050: *
051: * @param description DOCUMENTATION PENDING
052: *
053: * @throws QuestionPoolException DOCUMENTATION PENDING
054: */
055: void updateDescription(String description)
056: throws QuestionPoolException;
057:
058: /**
059: * DOCUMENTATION PENDING
060: *
061: * @param data DOCUMENTATION PENDING
062: *
063: * @throws QuestionPoolException DOCUMENTATION PENDING
064: */
065: void updateData(java.io.Serializable data)
066: throws QuestionPoolException;
067:
068: /**
069: * DOCUMENTATION PENDING
070: *
071: * @return DOCUMENTATION PENDING
072: *
073: * @throws QuestionPoolException DOCUMENTATION PENDING
074: */
075: String getDisplayName() throws QuestionPoolException;
076:
077: /**
078: * DOCUMENTATION PENDING
079: *
080: * @return DOCUMENTATION PENDING
081: *
082: * @throws QuestionPoolException DOCUMENTATION PENDING
083: */
084: String getDescription() throws QuestionPoolException;
085:
086: /**
087: * DOCUMENTATION PENDING
088: *
089: * @return DOCUMENTATION PENDING
090: *
091: * @throws QuestionPoolException DOCUMENTATION PENDING
092: */
093: Id getId() throws QuestionPoolException;
094:
095: /**
096: * DOCUMENTATION PENDING
097: *
098: * @return DOCUMENTATION PENDING
099: *
100: * @throws QuestionPoolException DOCUMENTATION PENDING
101: */
102: Type getQuestionPoolType() throws QuestionPoolException;
103:
104: /**
105: * DOCUMENTATION PENDING
106: *
107: * @return DOCUMENTATION PENDING
108: *
109: * @throws QuestionPoolException DOCUMENTATION PENDING
110: */
111: Serializable getData() throws QuestionPoolException;
112:
113: /**
114: * DOCUMENTATION PENDING
115: *
116: * @return DOCUMENTATION PENDING
117: *
118: * @throws QuestionPoolException DOCUMENTATION PENDING
119: */
120: Id getParentId() throws QuestionPoolException;
121:
122: /**
123: * DOCUMENTATION PENDING
124: *
125: * @return DOCUMENTATION PENDING
126: *
127: * @throws QuestionPoolException DOCUMENTATION PENDING
128: */
129: QuestionPool getParentPool() throws QuestionPoolException;
130:
131: /**
132: * DOCUMENTATION PENDING
133: *
134: * @return DOCUMENTATION PENDING
135: *
136: * @throws QuestionPoolException DOCUMENTATION PENDING
137: */
138: void setParentId(Id parentId) throws QuestionPoolException;
139:
140: }
|