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

All Known Implementing Classes:
QuestionPoolServiceImpl

public interface QuestionPoolServiceAPI

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

Author:
Ed Smiley

Method Summary
 void addItemToPool(String itemId, Long poolId)
          Save a question to a pool.
 void copyPool(Tree tree, String agentId, Long sourceId, Long destId)
          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)
          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.
 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(String 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(String questionId, Long poolId)
          removes a Question from the question pool.
 QuestionPoolDataIfc savePool(QuestionPoolDataIfc pool)
          Save a question pool.
 

Method Detail

getAllPools

public List getAllPools(String agentId)
Get all pools from the back end.


getBasicInfoOfAllPools

public List getBasicInfoOfAllPools(String agentId)
Get basic info for pools(just id and title) for displaying in pulldown .


getPool

public QuestionPoolDataIfc getPool(Long poolId,
                                   String agentId)
Get a particular pool from the backend, with all questions.


getPoolIdsByItem

public List getPoolIdsByItem(String itemId)
Get a list of pools that have a specific Agent


hasItem

public boolean hasItem(String itemId,
                       Long poolId)

getPoolIdsByAgent

public List getPoolIdsByAgent(String agentId)
Get pool id's by agent.


getSubPools

public List getSubPools(Long poolId)
Get a list of pools that have a specific parent


getSubPoolSize

public int getSubPoolSize(Long poolId)
Get the size of a subpool.


hasSubPools

public boolean hasSubPools(Long poolId)
Checks to see if a pool has subpools


getAllItemsSorted

public List getAllItemsSorted(Long poolId,
                              String orderBy)
Get all items sorted by orderby


getAllItems

public List getAllItems(Long poolId)
Get all scores for a published assessment from the back end.


addItemToPool

public void addItemToPool(String itemId,
                          Long poolId)
Save a question to a pool.


moveItemToPool

public void moveItemToPool(String itemId,
                           Long sourceId,
                           Long destId)
Move a question to a pool.


isDescendantOf

public boolean isDescendantOf(Long poolA,
                              Long poolB,
                              String agentId)
Is a pool a descendant of the other?


movePool

public void movePool(String agentId,
                     Long sourceId,
                     Long destId)
Move a subpool to a pool.


deletePool

public void deletePool(Long poolId,
                       String agentId,
                       Tree tree)
Delete a pool


removeQuestionFromPool

public void removeQuestionFromPool(String questionId,
                                   Long poolId)
removes a Question from the question pool. This does not *delete* the question itself


copyPool

public void copyPool(Tree tree,
                     String agentId,
                     Long sourceId,
                     Long destId)
Copy a subpool to a pool.


savePool

public QuestionPoolDataIfc savePool(QuestionPoolDataIfc pool)
Save a question pool.


getQuestionPoolItemMap

public Map getQuestionPoolItemMap()