org.sakaiproject.tool.assessment.shared.api.questionpool

Interface QuestionPoolServiceAPI

public interface QuestionPoolServiceAPI

The QuestionPoolServiceAPI declares a shared interface to control question pool information.

Author:

Ed Smiley

Method Summary

Modifier and Type	Method and Description
void	addItemToPool(Long itemId, Long poolId) Save a question to a pool.
void	copyPool(Tree tree, String agentId, Long sourceId, Long destId, String prependString1, String prependString2) Copy a subpool to a pool.
void	deletePool(Long poolId, String agentId, Tree tree) Delete a pool
List	getAllItems(Long poolId) Get all scores for a published assessment from the back end.
List	getAllItemsSorted(Long poolId, String orderBy, String ascending) Get all items sorted by orderby
List	getAllPools(String agentId) Get all pools from the back end.
List	getBasicInfoOfAllPools(String agentId) Get basic info for pools(just id and title) for displaying in pulldown .
QuestionPoolDataIfc	getPool(Long poolId, String agentId) Get a particular pool from the backend, with all questions.
List	getPoolIdsByAgent(String agentId) Get pool id's by agent.
List	getPoolIdsByItem(String itemId) Get a list of pools that have a specific Agent
Map	getQuestionPoolItemMap()
List	getSubPools(Long poolId) Get a list of pools that have a specific parent
int	getSubPoolSize(Long poolId) Get the size of a subpool.
String	getUserPoolAttachmentReport(String userId, Long poolId, String contextToReplace)
boolean	hasItem(String itemId, Long poolId)
boolean	hasSubPools(Long poolId) Checks to see if a pool has subpools
boolean	isDescendantOf(Long poolA, Long poolB, String agentId) Is a pool a descendant of the other?
void	moveItemToPool(Long itemId, Long sourceId, Long destId) Move a question to a pool.
void	movePool(String agentId, Long sourceId, Long destId) Move a subpool to a pool.
void	removeQuestionFromPool(Long questionId, Long poolId) removes a Question from the question pool.
QuestionPoolDataIfc	savePool(QuestionPoolDataIfc pool) Save a question pool.

Method Detail

getAllPools

List getAllPools(String agentId)

Get all pools from the back end.

getBasicInfoOfAllPools

List getBasicInfoOfAllPools(String agentId)

Get basic info for pools(just id and title) for displaying in pulldown .

getPool

QuestionPoolDataIfc getPool(Long poolId,
                            String agentId)

Get a particular pool from the backend, with all questions.

getPoolIdsByItem

List getPoolIdsByItem(String itemId)

Get a list of pools that have a specific Agent

hasItem

boolean hasItem(String itemId,
                Long poolId)

getPoolIdsByAgent

List getPoolIdsByAgent(String agentId)

Get pool id's by agent.

getSubPools

List getSubPools(Long poolId)

Get a list of pools that have a specific parent

getSubPoolSize

int getSubPoolSize(Long poolId)

Get the size of a subpool.

hasSubPools

boolean hasSubPools(Long poolId)

Checks to see if a pool has subpools

getAllItemsSorted

List getAllItemsSorted(Long poolId,
                       String orderBy,
                       String ascending)

Get all items sorted by orderby

getAllItems

List getAllItems(Long poolId)

Get all scores for a published assessment from the back end.

addItemToPool

void addItemToPool(Long itemId,
                   Long poolId)

Save a question to a pool.

moveItemToPool

void moveItemToPool(Long itemId,
                    Long sourceId,
                    Long destId)

Move a question to a pool.

isDescendantOf

boolean isDescendantOf(Long poolA,
                       Long poolB,
                       String agentId)

Is a pool a descendant of the other?

movePool

void movePool(String agentId,
              Long sourceId,
              Long destId)

Move a subpool to a pool.

deletePool

void deletePool(Long poolId,
                String agentId,
                Tree tree)

Delete a pool

removeQuestionFromPool

void removeQuestionFromPool(Long questionId,
                            Long poolId)

removes a Question from the question pool. This does not *delete* the question itself

copyPool

void copyPool(Tree tree,
              String agentId,
              Long sourceId,
              Long destId,
              String prependString1,
              String prependString2)

Copy a subpool to a pool.

savePool

QuestionPoolDataIfc savePool(QuestionPoolDataIfc pool)

Save a question pool.

getQuestionPoolItemMap

Map getQuestionPoolItemMap()

getUserPoolAttachmentReport

String getUserPoolAttachmentReport(String userId,
                                   Long poolId,
                                   String contextToReplace)