Java Doc for BaseAssignmentService.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » assignment » impl » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.assignment.impl 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.sakaiproject.assignment.impl.BaseAssignmentService

All known Subclasses:   org.sakaiproject.assignment.impl.DbAssignmentService,
BaseAssignmentService
abstract public class BaseAssignmentService implements AssignmentService,EntityTransferrer(Code)

BaseAssignmentService is the abstract service class for Assignments.

The Concrete Service classes extending this are the XmlFile and DbCached storage classes.


Inner Class :public class BaseAssignment implements Assignment
Inner Class :public class BaseAssignmentEdit extends BaseAssignment implements AssignmentEdit,SessionBindingListener
Inner Class :public class BaseAssignmentContent implements AssignmentContent
Inner Class :public class BaseAssignmentContentEdit extends BaseAssignmentContent implements AttachmentContainer,AssignmentContentEdit,SessionBindingListener
Inner Class :public class BaseAssignmentSubmission implements AssignmentSubmission
Inner Class :public class BaseAssignmentSubmissionEdit extends BaseAssignmentSubmission implements AssignmentSubmissionEdit,SessionBindingListener
Inner Class :protected interface AssignmentStorage
Inner Class :protected interface AssignmentContentStorage
Inner Class :protected interface AssignmentSubmissionStorage
Inner Class :protected class AssignmentStorageUser implements StorageUser
Inner Class :protected class AssignmentContentStorageUser implements StorageUser
Inner Class :protected class AssignmentSubmissionStorageUser implements StorageUser
Inner Class :protected class AssignmentCacheRefresher implements CacheRefresher
Inner Class :protected class AssignmentContentCacheRefresher implements CacheRefresher
Inner Class :protected class AssignmentSubmissionCacheRefresher implements CacheRefresher

Field Summary
final public static  StringEVENT_ACCESS_ASSIGNMENT
     Event for accessing an assignment.
final public static  StringEVENT_ACCESS_ASSIGNMENT_CONTENT
     Event for accessing an assignment content.
final public static  StringEVENT_ACCESS_ASSIGNMENT_SUBMISSION
     Event for accessing an assignment submission.
final public static  StringEVENT_ADD_ASSIGNMENT
     Event for adding an assignment.
final public static  StringEVENT_ADD_ASSIGNMENT_CONTENT
     Event for adding an assignment.
final public static  StringEVENT_ADD_ASSIGNMENT_SUBMISSION
     Event for adding an assignment submission.
final public static  StringEVENT_GRADE_ASSIGNMENT_SUBMISSION
     Event for grading an assignment submission.
final public static  StringEVENT_REMOVE_ASSIGNMENT
     Event for removing an assignment.
final public static  StringEVENT_REMOVE_ASSIGNMENT_CONTENT
     Event for removing an assignment content.
final public static  StringEVENT_REMOVE_ASSIGNMENT_SUBMISSION
     Event for removing an assignment submission.
final public static  StringEVENT_SAVE_ASSIGNMENT_SUBMISSION
     Event for saving an assignment submission.
final public static  StringEVENT_SUBMIT_ASSIGNMENT_SUBMISSION
     Event for submitting an assignment submission.
final public static  StringEVENT_UPDATE_ASSIGNMENT
     Event for updating an assignment.
final public static  StringEVENT_UPDATE_ASSIGNMENT_CONTENT
     Event for updating an assignment content.
final public static  StringEVENT_UPDATE_ASSIGNMENT_SUBMISSION
     Event for updating an assignment submission.
protected  booleanm_allowGroupAssignments
    
protected  booleanm_allowGroupAssignmentsInGradebook
    
protected  Cachem_assignmentCache
     A Cache for this service - Assignments keyed by reference.
protected  AssignmentStoragem_assignmentStorage
     A Storage object for persistent storage of Assignments.
protected  booleanm_caching
     Configuration: cache, or not.
protected  Cachem_contentCache
     A Cache for this service - AssignmentContents keyed by reference.
protected  AssignmentContentStoragem_contentStorage
     A Storage object for persistent storage of Assignments.
protected  EntityManagerm_entityManager
     Dependency: EntityManager.
protected  MemoryServicem_memoryService
     Dependency: MemoryService.
protected  Stringm_relativeAccessPoint
     The access point URL.
protected  ServerConfigurationServicem_serverConfigurationService
     Dependency: ServerConfigurationService.
protected  Cachem_submissionCache
     A Cache for this service - AssignmentSubmissions keyed by reference.
protected  AssignmentSubmissionStoragem_submissionStorage
     A Storage object for persistent storage of Assignments.


Method Summary
protected  voidWTUserIdTrans(Element el, Map userIdTrans)
    
public  AssignmentEditaddAssignment(String context)
     Creates and adds a new Assignment to the service.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
public  AssignmentContentEditaddAssignmentContent(String context)
     Creates and adds a new AssignmentContent to the service.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
public  AssignmentEditaddDuplicateAssignment(String context, String assignmentReference)
     Creates and adds a new Assignment to the service which is a copy of an existing Assignment.
Parameters:
  assignmentId - -The Assignment to be duplicated.
public  AssignmentContentEditaddDuplicateAssignmentContent(String context, String contentReference)
     Creates and adds a new AssignmentContent to the service which is a copy of an existing AssignmentContent.
Parameters:
  context - -From DefaultId.getChannel(RunData)
Parameters:
  contentReference - -The id of the AssignmentContent to be duplicated.
protected  voidaddLiveProperties(ResourcePropertiesEdit props)
     Create the live properties for the object.
protected  voidaddLiveUpdateProperties(ResourcePropertiesEdit props)
     Update the live properties for an object when modified.
public  AssignmentSubmissionEditaddSubmission(String context, String assignmentId)
     Adds an AssignmentSubmission to the service.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
public  booleanallowAddAssignment(String context)
     Check permissions for adding an Assignment.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
public  booleanallowAddAssignmentContent(String context)
     Check permissions for adding an AssignmentContent.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
public  ListallowAddAssignmentUsers(String context)
    
public  booleanallowAddGroupAssignment(String context)
     check permissions for addAssignment().
public  booleanallowAddSiteAssignment(String context)
    
public  booleanallowAddSubmission(String context)
     Check permissions for add AssignmentSubmission
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
public  ListallowAddSubmissionUsers(String assignmentReference)
     Get the List of Users who can addSubmission() for this assignment.
public  booleanallowGetAssignment(String context)
    
public  booleanallowGetAssignmentContent(String context)
     Check permissions for get AssignmentContent
Parameters:
  contentReference - -The AssignmentContent reference.
public  booleanallowGetSubmission(String submissionReference)
     Check permissions for accessing a Submission.
Parameters:
  submissionReference - -The Submission's reference.
public  booleanallowGradeSubmission(String assignmentReference)
    
public  booleanallowRemoveAssignment(String assignmentReference)
     Check permissions for removing an Assignment.
public  booleanallowRemoveAssignmentContent(String contentReference)
     Check permissions for remove the AssignmentContent
Parameters:
  contentReference - -The AssignmentContent reference.
public  booleanallowRemoveSubmission(String submissionReference)
     Check permissions for remove Submission
Parameters:
  submissionReference - -The Submission's reference.
public  booleanallowUpdateAssignment(String assignmentReference)
     Check permissions for updateing an Assignment.
Parameters:
  assignmentReference - -The Assignment's reference.
public  booleanallowUpdateAssignmentContent(String contentReference)
     Check permissions for updating AssignmentContent
Parameters:
  contentReference - -The AssignmentContent reference.
public  booleanallowUpdateSubmission(String submissionReference)
     Check permissions for updating Submission.
Parameters:
  submissionReference - -The Submission's reference.
public  Stringarchive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
    
protected  StringassignmentId(String ref)
     Access the assignment id extracted from an assignment reference.
Parameters:
  ref - The assignment reference string.
public  StringassignmentReference(String context, String id)
     Access the internal reference which can be used to assess security clearance.
Parameters:
  id - The assignment id string.
public  voidcancelEdit(AssignmentEdit assignment)
     Cancel the changes made to a AssignmentEdit object, and release the lock.
public  voidcancelEdit(AssignmentContentEdit content)
     Cancel the changes made to a AssignmentContentEdit object, and release the lock.
public  voidcancelEdit(AssignmentSubmissionEdit submission)
     Cancel the changes made to a AssignmentSubmissionEdit object, and release the lock.
public  voidcommitEdit(AssignmentEdit assignment)
     Commit the changes made to an AssignmentEdit object, and release the lock.
public  voidcommitEdit(AssignmentContentEdit content)
     Commit the changes made to an AssignmentContentEdit object, and release the lock.
public  voidcommitEdit(AssignmentSubmissionEdit submission)
     Commit the changes made to an AssignmentSubmissionEdit object, and release the lock.
protected  StringcontentId(String ref)
     Access the content id extracted from a content reference.
Parameters:
  ref - The content reference string.
public  StringcontentReference(String context, String id)
     Access the internal reference which can be used to access the resource from within the system.
Parameters:
  id - The content id string.
public  voiddestroy()
     Returns to uninitialized state.
public  AssignmentEditeditAssignment(String assignmentReference)
     Get a locked assignment object for editing.
public  AssignmentContentEditeditAssignmentContent(String contentReference)
     Get a locked AssignmentContent object for editing.
public  AssignmentSubmissionEditeditSubmission(String submissionReference)
     Get a locked AssignmentSubmission object for editing.
protected  AssignmentfindAssignment(String assignmentReference)
    
protected  StringgetAccessPoint(boolean relative)
     Access the partial URL that forms the root of resource URLs.
Parameters:
  relative - -if true, form within the access path only (i.e.
public  booleangetAllowGroupAssignments()
    
public  booleangetAllowGroupAssignmentsInGradebook()
    
public  AssignmentgetAssignment(String assignmentReference)
     Access the Assignment with the specified reference.
Parameters:
  assignmentReference - -The reference of the Assignment.
public  AssignmentContentgetAssignmentContent(String contentReference)
     Access the AssignmentContent with the specified reference.
Parameters:
  contentReference - -The reference of the AssignmentContent.
protected  ListgetAssignmentContents(String context)
     Access all AssignmentContent objects - known to us (not from external providers).
public  IteratorgetAssignmentContents(User owner)
     Access list of all AssignmentContents created by the User.
Parameters:
  owner - -The User who's AssignmentContents are requested.
protected  ListgetAssignments(String context)
     Access all assignment objects - known to us (not from external providers).
public  IteratorgetAssignments(AssignmentContent content)
     Access all the Assignments which have the specified AssignmentContent.
Parameters:
  content - -The particular AssignmentContent.
public  IteratorgetAssignmentsForContext(String context)
     Access all the Assignemnts associated with a group.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel().
protected  booleangetBool(String s)
     Utility function which returns a boolean value from a string.
Parameters:
  s - -The input string.
protected  StringgetBoolString(boolean b)
     Utility function which returns a string from a boolean value.
Parameters:
  b - -the boolean value.
public  EntitygetEntity(Reference ref)
    
public  CollectiongetEntityAuthzGroups(Reference ref, String userId)
    
public  StringgetEntityDescription(Reference ref)
    
public  ResourcePropertiesgetEntityResourceProperties(Reference ref)
    
public  StringgetEntityUrl(Reference ref)
    
public  byte[]getGradesSpreadsheet(String ref)
     Access the grades spreadsheet for the reference, either for an assignment or all assignments in a context.
Parameters:
  ref - The reference, either to a specific assignment, or just to an assignment context.
protected  StringgetGroupNameFromContext(String context)
    
public  CollectiongetGroupsAllowAddAssignment(String context)
    
protected  CollectiongetGroupsAllowFunction(String function, String context)
     Get the groups of this channel's contex-site that the end user has permission to "function" in.
public  CollectiongetGroupsAllowGetAssignment(String context)
    
public  CollectiongetGroupsAllowRemoveAssignment(String context)
    
public  HttpAccessgetHttpAccess()
    
public  StringgetLabel()
    
public  ListgetListAssignmentsForContext(String context)
    
protected  StringgetReferenceRoot()
     Return the reference root for use in resource references and urls.
public  AssignmentSubmissiongetSubmission(String assignmentReference, User person)
     Access a User's AssignmentSubmission to a particular Assignment.
Parameters:
  assignmentReference - The reference of the assignment.
Parameters:
  person - -The User who's Submission you would like.
public  AssignmentSubmissiongetSubmission(String submissionReference)
     Access the AssignmentSubmission with the specified id.
Parameters:
  submissionReference - -The reference of the AssignmentSubmission.
protected  ListgetSubmissions(String context)
     Access all AssignmentSubmission objects - known to us (not from external providers).
public  IteratorgetSubmissions(Assignment assignment)
     Get the submissions for an assignment.
Parameters:
  assignment - -the Assignment who's submissions you would like.
public  byte[]getSubmissionsZip(String ref)
     Access the submissions zip for the assignment reference.
Parameters:
  ref - The assignment reference.
protected  TimegetTimeObject(String timeString)
     Utility function which converts a string into a chef time object.
Parameters:
  timeString - -String version of a time in long format, representing the standard ms since the epoch, Jan 1, 1970 00:00:00.
protected  StringgetTimeString(Time t)
     Utility function which returns the string representation of the long value of the time object.
Parameters:
  t - -the Time object.
public  StringgradesSpreadsheetReference(String context, String assignmentId)
    
public  voidinit()
     Final initialization, once all dependencies are set.
protected  booleanisIntersectionGroupRefsToGroups(Collection groupRefs, Collection groups)
     See if the collection of group reference strings has at least one group that is in the collection of Group objects.
Parameters:
  groupRefs - The collection (String) of group references.
Parameters:
  groups - The collection (Group) of group objects.
public  Stringmerge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)
    
public  AssignmentEditmergeAssignment(Element el)
     Add a new assignment to the directory, from a definition in XML.
public  AssignmentContentEditmergeAssignmentContent(Element el)
     Add a new AssignmentContent to the directory, from a definition in XML.
public  AssignmentSubmissionEditmergeSubmission(Element el)
     Add a new AssignmentSubmission to the directory, from a definition in XML.
public  String[]myToolIds()
    
abstract protected  AssignmentStoragenewAssignmentStorage()
     Construct a Storage object for Assignments.
abstract protected  AssignmentContentStoragenewContentStorage()
     Construct a Storage object for AssignmentContents.
abstract protected  AssignmentSubmissionStoragenewSubmissionStorage()
     Construct a Storage object for AssignmentSubmissions.
public  booleanparseEntityReference(String reference, Reference ref)
    
public  voidremoveAssignment(AssignmentEdit assignment)
     Removes this Assignment and all references to it.
public  voidremoveAssignmentContent(AssignmentContentEdit content)
    
public  voidremoveSubmission(AssignmentSubmissionEdit submission)
    
public  voidsetAllowGroupAssignments(boolean allowGroupAssignments)
    
public  voidsetAllowGroupAssignmentsInGradebook(boolean allowGroupAssignmentsInGradebook)
    
public  voidsetCaching(String value)
    
public  voidsetEntityManager(EntityManager service)
     Dependency: EntityManager.
public  voidsetMemoryService(MemoryService service)
     Dependency: MemoryService.
public  voidsetServerConfigurationService(ServerConfigurationService service)
     Dependency: ServerConfigurationService.
protected  StringsubmissionId(String ref)
     Access the submission id extracted from a submission reference.
Parameters:
  ref - The submission reference string.
public  StringsubmissionReference(String context, String id, String assignmentId)
     Access the internal reference which can be used to access the resource from within the system.
Parameters:
  id - The submission id string.
public  StringsubmissionsZipReference(String context, String assignmentReference)
    
public  voidtransferCopyEntities(String fromContext, String toContext, List resourceIds)
    
protected  voidunlock(String lock, String resource)
     Check security permission.
protected  voidunlock2(String lock1, String lock2, String resource)
     Check security permission.
protected  booleanunlockCheck(String lock, String resource)
     Check security permission.
Parameters:
  lock - -The lock id string.
Parameters:
  resource - -The resource reference string, or null if no resource is involved.
protected  booleanunlockCheck2(String lock1, String lock2, String resource)
     Check security permission.
Parameters:
  lock1 - The lock id string.
Parameters:
  lock2 - The lock id string.
Parameters:
  resource - The resource reference string, or null if no resource is involved.
public  booleanwillArchiveMerge()
    

Field Detail
EVENT_ACCESS_ASSIGNMENT
final public static String EVENT_ACCESS_ASSIGNMENT(Code)
Event for accessing an assignment.



EVENT_ACCESS_ASSIGNMENT_CONTENT
final public static String EVENT_ACCESS_ASSIGNMENT_CONTENT(Code)
Event for accessing an assignment content.



EVENT_ACCESS_ASSIGNMENT_SUBMISSION
final public static String EVENT_ACCESS_ASSIGNMENT_SUBMISSION(Code)
Event for accessing an assignment submission.



EVENT_ADD_ASSIGNMENT
final public static String EVENT_ADD_ASSIGNMENT(Code)
Event for adding an assignment.



EVENT_ADD_ASSIGNMENT_CONTENT
final public static String EVENT_ADD_ASSIGNMENT_CONTENT(Code)
Event for adding an assignment.



EVENT_ADD_ASSIGNMENT_SUBMISSION
final public static String EVENT_ADD_ASSIGNMENT_SUBMISSION(Code)
Event for adding an assignment submission.



EVENT_GRADE_ASSIGNMENT_SUBMISSION
final public static String EVENT_GRADE_ASSIGNMENT_SUBMISSION(Code)
Event for grading an assignment submission.



EVENT_REMOVE_ASSIGNMENT
final public static String EVENT_REMOVE_ASSIGNMENT(Code)
Event for removing an assignment.



EVENT_REMOVE_ASSIGNMENT_CONTENT
final public static String EVENT_REMOVE_ASSIGNMENT_CONTENT(Code)
Event for removing an assignment content.



EVENT_REMOVE_ASSIGNMENT_SUBMISSION
final public static String EVENT_REMOVE_ASSIGNMENT_SUBMISSION(Code)
Event for removing an assignment submission.



EVENT_SAVE_ASSIGNMENT_SUBMISSION
final public static String EVENT_SAVE_ASSIGNMENT_SUBMISSION(Code)
Event for saving an assignment submission.



EVENT_SUBMIT_ASSIGNMENT_SUBMISSION
final public static String EVENT_SUBMIT_ASSIGNMENT_SUBMISSION(Code)
Event for submitting an assignment submission.



EVENT_UPDATE_ASSIGNMENT
final public static String EVENT_UPDATE_ASSIGNMENT(Code)
Event for updating an assignment.



EVENT_UPDATE_ASSIGNMENT_CONTENT
final public static String EVENT_UPDATE_ASSIGNMENT_CONTENT(Code)
Event for updating an assignment content.



EVENT_UPDATE_ASSIGNMENT_SUBMISSION
final public static String EVENT_UPDATE_ASSIGNMENT_SUBMISSION(Code)
Event for updating an assignment submission.



m_allowGroupAssignments
protected boolean m_allowGroupAssignments(Code)
Dependency: allowGroupAssignments setting



m_allowGroupAssignmentsInGradebook
protected boolean m_allowGroupAssignmentsInGradebook(Code)
Dependency: allowGroupAssignmentsInGradebook setting



m_assignmentCache
protected Cache m_assignmentCache(Code)
A Cache for this service - Assignments keyed by reference.



m_assignmentStorage
protected AssignmentStorage m_assignmentStorage(Code)
A Storage object for persistent storage of Assignments.



m_caching
protected boolean m_caching(Code)
Configuration: cache, or not.



m_contentCache
protected Cache m_contentCache(Code)
A Cache for this service - AssignmentContents keyed by reference.



m_contentStorage
protected AssignmentContentStorage m_contentStorage(Code)
A Storage object for persistent storage of Assignments.



m_entityManager
protected EntityManager m_entityManager(Code)
Dependency: EntityManager.



m_memoryService
protected MemoryService m_memoryService(Code)
Dependency: MemoryService.



m_relativeAccessPoint
protected String m_relativeAccessPoint(Code)
The access point URL.



m_serverConfigurationService
protected ServerConfigurationService m_serverConfigurationService(Code)
Dependency: ServerConfigurationService.



m_submissionCache
protected Cache m_submissionCache(Code)
A Cache for this service - AssignmentSubmissions keyed by reference.



m_submissionStorage
protected AssignmentSubmissionStorage m_submissionStorage(Code)
A Storage object for persistent storage of Assignments.





Method Detail
WTUserIdTrans
protected void WTUserIdTrans(Element el, Map userIdTrans)(Code)
Replace the WT user id with the new qualified id
Parameters:
  el - The XML element holding the perproties
Parameters:
  useIdTrans - The HashMap to track old WT id to new CTools id



addAssignment
public AssignmentEdit addAssignment(String context) throws PermissionException(Code)
Creates and adds a new Assignment to the service.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). The new Assignment object.
throws:
  IdInvalidException - if the id contains prohibited characers.
throws:
  IdUsedException - if the id is already used in the service.
throws:
  PermissionException - if current User does not have permission to do this.



addAssignmentContent
public AssignmentContentEdit addAssignmentContent(String context) throws PermissionException(Code)
Creates and adds a new AssignmentContent to the service.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). AssignmentContent The new AssignmentContent object.
throws:
  PermissionException - if current User does not have permission to do this.



addDuplicateAssignment
public AssignmentEdit addDuplicateAssignment(String context, String assignmentReference) throws PermissionException, IdInvalidException, IdUsedException, IdUnusedException(Code)
Creates and adds a new Assignment to the service which is a copy of an existing Assignment.
Parameters:
  assignmentId - -The Assignment to be duplicated. The new Assignment object, or null if the original Assignment does not exist.
throws:
  PermissionException - if current User does not have permission to do this.



addDuplicateAssignmentContent
public AssignmentContentEdit addDuplicateAssignmentContent(String context, String contentReference) throws PermissionException, IdInvalidException, IdUnusedException(Code)
Creates and adds a new AssignmentContent to the service which is a copy of an existing AssignmentContent.
Parameters:
  context - -From DefaultId.getChannel(RunData)
Parameters:
  contentReference - -The id of the AssignmentContent to be duplicated. AssignmentContentEdit The new AssignmentContentEdit object, or null if the original does not exist.
throws:
  PermissionException - if current User does not have permission to do this.



addLiveProperties
protected void addLiveProperties(ResourcePropertiesEdit props)(Code)
Create the live properties for the object.



addLiveUpdateProperties
protected void addLiveUpdateProperties(ResourcePropertiesEdit props)(Code)
Update the live properties for an object when modified.



addSubmission
public AssignmentSubmissionEdit addSubmission(String context, String assignmentId) throws PermissionException(Code)
Adds an AssignmentSubmission to the service.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). The new AssignmentSubmission.
exception:
  IdInvalidException - if the submission id is invalid.
exception:
  IdUsedException - if the submission id is already used.
throws:
  PermissionException - if the current User does not have permission to do this.



allowAddAssignment
public boolean allowAddAssignment(String context)(Code)
Check permissions for adding an Assignment.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). True if the current User is allowed to add an Assignment, false if not.



allowAddAssignmentContent
public boolean allowAddAssignmentContent(String context)(Code)
Check permissions for adding an AssignmentContent.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). True if the current User is allowed to add an AssignmentContent, false if not.



allowAddAssignmentUsers
public List allowAddAssignmentUsers(String context)(Code)
Get the List of Users who can add assignment
Parameters:
  assignmentReference - -a reference to an assignment the List (User) of users who can addSubmission() for this assignment.



allowAddGroupAssignment
public boolean allowAddGroupAssignment(String context)(Code)
check permissions for addAssignment().
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel() true if the user is allowed to addAssignment(...), false if not.



allowAddSiteAssignment
public boolean allowAddSiteAssignment(String context)(Code)



allowAddSubmission
public boolean allowAddSubmission(String context)(Code)
Check permissions for add AssignmentSubmission
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). True if the current User is allowed to add an AssignmentSubmission, false if not.



allowAddSubmissionUsers
public List allowAddSubmissionUsers(String assignmentReference)(Code)
Get the List of Users who can addSubmission() for this assignment.
Parameters:
  assignmentReference - -a reference to an assignment the List (User) of users who can addSubmission() for this assignment.



allowGetAssignment
public boolean allowGetAssignment(String context)(Code)



allowGetAssignmentContent
public boolean allowGetAssignmentContent(String context)(Code)
Check permissions for get AssignmentContent
Parameters:
  contentReference - -The AssignmentContent reference. True if the current User is allowed to access the AssignmentContent, false if not.



allowGetSubmission
public boolean allowGetSubmission(String submissionReference)(Code)
Check permissions for accessing a Submission.
Parameters:
  submissionReference - -The Submission's reference. True if the current User is allowed to get the AssignmentSubmission, false if not.



allowGradeSubmission
public boolean allowGradeSubmission(String assignmentReference)(Code)



allowRemoveAssignment
public boolean allowRemoveAssignment(String assignmentReference)(Code)
Check permissions for removing an Assignment. True if the current User is allowed to remove the Assignment, false if not.



allowRemoveAssignmentContent
public boolean allowRemoveAssignmentContent(String contentReference)(Code)
Check permissions for remove the AssignmentContent
Parameters:
  contentReference - -The AssignmentContent reference. True if the current User is allowed to remove the AssignmentContent, false if not.



allowRemoveSubmission
public boolean allowRemoveSubmission(String submissionReference)(Code)
Check permissions for remove Submission
Parameters:
  submissionReference - -The Submission's reference. True if the current User is allowed to remove the AssignmentSubmission, false if not.



allowUpdateAssignment
public boolean allowUpdateAssignment(String assignmentReference)(Code)
Check permissions for updateing an Assignment.
Parameters:
  assignmentReference - -The Assignment's reference. True if the current User is allowed to update the Assignment, false if not.



allowUpdateAssignmentContent
public boolean allowUpdateAssignmentContent(String contentReference)(Code)
Check permissions for updating AssignmentContent
Parameters:
  contentReference - -The AssignmentContent reference. True if the current User is allowed to update the AssignmentContent, false if not.



allowUpdateSubmission
public boolean allowUpdateSubmission(String submissionReference)(Code)
Check permissions for updating Submission.
Parameters:
  submissionReference - -The Submission's reference. True if the current User is allowed to update the AssignmentSubmission, false if not.



archive
public String archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)(Code)



assignmentId
protected String assignmentId(String ref)(Code)
Access the assignment id extracted from an assignment reference.
Parameters:
  ref - The assignment reference string. The the assignment id extracted from an assignment reference.



assignmentReference
public String assignmentReference(String context, String id)(Code)
Access the internal reference which can be used to assess security clearance.
Parameters:
  id - The assignment id string. The the internal reference which can be used to access the resource from within the system.



cancelEdit
public void cancelEdit(AssignmentEdit assignment)(Code)
Cancel the changes made to a AssignmentEdit object, and release the lock.
Parameters:
  assignment - The AssignmentEdit object to commit.



cancelEdit
public void cancelEdit(AssignmentContentEdit content)(Code)
Cancel the changes made to a AssignmentContentEdit object, and release the lock.
Parameters:
  content - The AssignmentContentEdit object to commit.



cancelEdit
public void cancelEdit(AssignmentSubmissionEdit submission)(Code)
Cancel the changes made to a AssignmentSubmissionEdit object, and release the lock.
Parameters:
  submission - The AssignmentSubmissionEdit object to commit.



commitEdit
public void commitEdit(AssignmentEdit assignment)(Code)
Commit the changes made to an AssignmentEdit object, and release the lock.
Parameters:
  assignment - The AssignmentEdit object to commit.



commitEdit
public void commitEdit(AssignmentContentEdit content)(Code)
Commit the changes made to an AssignmentContentEdit object, and release the lock.
Parameters:
  content - The AssignmentContentEdit object to commit.



commitEdit
public void commitEdit(AssignmentSubmissionEdit submission)(Code)
Commit the changes made to an AssignmentSubmissionEdit object, and release the lock.
Parameters:
  submission - The AssignmentSubmissionEdit object to commit.



contentId
protected String contentId(String ref)(Code)
Access the content id extracted from a content reference.
Parameters:
  ref - The content reference string. The the content id extracted from a content reference.



contentReference
public String contentReference(String context, String id)(Code)
Access the internal reference which can be used to access the resource from within the system.
Parameters:
  id - The content id string. The the internal reference which can be used to access the resource from within the system.



destroy
public void destroy()(Code)
Returns to uninitialized state.



editAssignment
public AssignmentEdit editAssignment(String assignmentReference) throws IdUnusedException, PermissionException, InUseException(Code)
Get a locked assignment object for editing. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
  id - The assignment id string. An AssignmentEdit object for editing.
exception:
  IdUnusedException - if not found, or if not an AssignmentEdit object
exception:
  PermissionException - if the current user does not have permission to edit this assignment.
exception:
  InUseException - if the assignment is being edited by another user.



editAssignmentContent
public AssignmentContentEdit editAssignmentContent(String contentReference) throws IdUnusedException, PermissionException, InUseException(Code)
Get a locked AssignmentContent object for editing. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
  id - The content id string. An AssignmentContentEdit object for editing.
exception:
  IdUnusedException - if not found, or if not an AssignmentContentEdit object
exception:
  PermissionException - if the current user does not have permission to edit this content.
exception:
  InUseException - if the assignment is being edited by another user.



editSubmission
public AssignmentSubmissionEdit editSubmission(String submissionReference) throws IdUnusedException, PermissionException, InUseException(Code)
Get a locked AssignmentSubmission object for editing. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
  submissionrReference - -the reference for the submission. An AssignmentSubmissionEdit object for editing.
exception:
  IdUnusedException - if not found, or if not an AssignmentSubmissionEdit object
exception:
  PermissionException - if the current user does not have permission to edit this submission.
exception:
  InUseException - if the assignment is being edited by another user.



findAssignment
protected Assignment findAssignment(String assignmentReference)(Code)



getAccessPoint
protected String getAccessPoint(boolean relative)(Code)
Access the partial URL that forms the root of resource URLs.
Parameters:
  relative - -if true, form within the access path only (i.e. starting with /msg) the partial URL that forms the root of resource URLs.



getAllowGroupAssignments
public boolean getAllowGroupAssignments()(Code)
Get allowGroupAssignments



getAllowGroupAssignmentsInGradebook
public boolean getAllowGroupAssignmentsInGradebook()(Code)
Get allowGroupAssignmentsGradebook



getAssignment
public Assignment getAssignment(String assignmentReference) throws IdUnusedException, PermissionException(Code)
Access the Assignment with the specified reference.
Parameters:
  assignmentReference - -The reference of the Assignment. The Assignment corresponding to the reference, or null if it does not exist.
throws:
  IdUnusedException - if there is no object with this reference.
throws:
  PermissionException - if the current user is not allowed to access this.



getAssignmentContent
public AssignmentContent getAssignmentContent(String contentReference) throws IdUnusedException, PermissionException(Code)
Access the AssignmentContent with the specified reference.
Parameters:
  contentReference - -The reference of the AssignmentContent. The AssignmentContent corresponding to the reference, or null if it does not exist.
throws:
  IdUnusedException - if there is no object with this reference.
throws:
  PermissionException - if the current user is not allowed to access this.



getAssignmentContents
protected List getAssignmentContents(String context)(Code)
Access all AssignmentContent objects - known to us (not from external providers). A list of AssignmentContent objects.



getAssignmentContents
public Iterator getAssignmentContents(User owner)(Code)
Access list of all AssignmentContents created by the User.
Parameters:
  owner - -The User who's AssignmentContents are requested. Iterator over all AssignmentContents owned by this User.



getAssignments
protected List getAssignments(String context)(Code)
Access all assignment objects - known to us (not from external providers). A list of assignment objects.



getAssignments
public Iterator getAssignments(AssignmentContent content)(Code)
Access all the Assignments which have the specified AssignmentContent.
Parameters:
  content - -The particular AssignmentContent. Iterator over all the Assignments with the specified AssignmentContent.



getAssignmentsForContext
public Iterator getAssignmentsForContext(String context)(Code)
Access all the Assignemnts associated with a group.
Parameters:
  context - -Describes the portlet context - generated with DefaultId.getChannel(). Iterator over all the Assignments associated with a group.



getBool
protected boolean getBool(String s)(Code)
Utility function which returns a boolean value from a string.
Parameters:
  s - -The input string. the boolean true if the input string is "true", false otherwise.



getBoolString
protected String getBoolString(boolean b)(Code)
Utility function which returns a string from a boolean value.
Parameters:
  b - -the boolean value. - "True" if the input value is true, "false" otherwise.



getEntity
public Entity getEntity(Reference ref)(Code)



getEntityAuthzGroups
public Collection getEntityAuthzGroups(Reference ref, String userId)(Code)



getEntityDescription
public String getEntityDescription(Reference ref)(Code)



getEntityResourceProperties
public ResourceProperties getEntityResourceProperties(Reference ref)(Code)



getEntityUrl
public String getEntityUrl(Reference ref)(Code)



getGradesSpreadsheet
public byte[] getGradesSpreadsheet(String ref) throws IdUnusedException, PermissionException(Code)
Access the grades spreadsheet for the reference, either for an assignment or all assignments in a context.
Parameters:
  ref - The reference, either to a specific assignment, or just to an assignment context. The grades spreadsheet bytes.
throws:
  IdUnusedException - if there is no object with this id.
throws:
  PermissionException - if the current user is not allowed to access this.



getGroupNameFromContext
protected String getGroupNameFromContext(String context)(Code)



getGroupsAllowAddAssignment
public Collection getGroupsAllowAddAssignment(String context)(Code)



getGroupsAllowFunction
protected Collection getGroupsAllowFunction(String function, String context)(Code)
Get the groups of this channel's contex-site that the end user has permission to "function" in.
Parameters:
  function - The function to check



getGroupsAllowGetAssignment
public Collection getGroupsAllowGetAssignment(String context)(Code)



getGroupsAllowRemoveAssignment
public Collection getGroupsAllowRemoveAssignment(String context)(Code)



getHttpAccess
public HttpAccess getHttpAccess()(Code)



getLabel
public String getLabel()(Code)



getListAssignmentsForContext
public List getListAssignmentsForContext(String context)(Code)



getReferenceRoot
protected String getReferenceRoot()(Code)
Return the reference root for use in resource references and urls. The reference root for use in resource references and urls.



getSubmission
public AssignmentSubmission getSubmission(String assignmentReference, User person) throws IdUnusedException, PermissionException(Code)
Access a User's AssignmentSubmission to a particular Assignment.
Parameters:
  assignmentReference - The reference of the assignment.
Parameters:
  person - -The User who's Submission you would like. AssignmentSubmission The user's submission for that Assignment.
throws:
  IdUnusedException - if there is no object with this id.
throws:
  PermissionException - if the current user is not allowed to access this.



getSubmission
public AssignmentSubmission getSubmission(String submissionReference) throws IdUnusedException, PermissionException(Code)
Access the AssignmentSubmission with the specified id.
Parameters:
  submissionReference - -The reference of the AssignmentSubmission. The AssignmentSubmission corresponding to the id, or null if it does not exist.
throws:
  IdUnusedException - if there is no object with this id.
throws:
  PermissionException - if the current user is not allowed to access this.



getSubmissions
protected List getSubmissions(String context)(Code)
Access all AssignmentSubmission objects - known to us (not from external providers). A list of AssignmentSubmission objects.



getSubmissions
public Iterator getSubmissions(Assignment assignment)(Code)
Get the submissions for an assignment.
Parameters:
  assignment - -the Assignment who's submissions you would like. Iterator over all the submissions for an Assignment.



getSubmissionsZip
public byte[] getSubmissionsZip(String ref) throws IdUnusedException, PermissionException(Code)
Access the submissions zip for the assignment reference.
Parameters:
  ref - The assignment reference. The submissions zip bytes.
throws:
  IdUnusedException - if there is no object with this id.
throws:
  PermissionException - if the current user is not allowed to access this.



getTimeObject
protected Time getTimeObject(String timeString)(Code)
Utility function which converts a string into a chef time object.
Parameters:
  timeString - -String version of a time in long format, representing the standard ms since the epoch, Jan 1, 1970 00:00:00. A chef Time object.



getTimeString
protected String getTimeString(Time t)(Code)
Utility function which returns the string representation of the long value of the time object.
Parameters:
  t - -the Time object. A String representation of the long value of the time object.



gradesSpreadsheetReference
public String gradesSpreadsheetReference(String context, String assignmentId)(Code)
Get the string to form an assignment grade spreadsheet
Parameters:
  context - The assignment context String
Parameters:
  assignmentId - The id for the assignment object; when null, indicates all assignment in that context



init
public void init()(Code)
Final initialization, once all dependencies are set.



isIntersectionGroupRefsToGroups
protected boolean isIntersectionGroupRefsToGroups(Collection groupRefs, Collection groups)(Code)
See if the collection of group reference strings has at least one group that is in the collection of Group objects.
Parameters:
  groupRefs - The collection (String) of group references.
Parameters:
  groups - The collection (Group) of group objects. true if there is interesection, false if not.



merge
public String merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)(Code)



mergeAssignment
public AssignmentEdit mergeAssignment(Element el) throws IdInvalidException, IdUsedException, PermissionException(Code)
Add a new assignment to the directory, from a definition in XML. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
  el - The XML DOM Element defining the assignment. A locked AssignmentEdit object (reserving the id).
exception:
  IdInvalidException - if the assignment id is invalid.
exception:
  IdUsedException - if the assignment id is already used.
exception:
  PermissionException - if the current user does not have permission to add an assignnment.



mergeAssignmentContent
public AssignmentContentEdit mergeAssignmentContent(Element el) throws IdInvalidException, IdUsedException, PermissionException(Code)
Add a new AssignmentContent to the directory, from a definition in XML. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
  el - The XML DOM Element defining the AssignmentContent. A locked AssignmentContentEdit object (reserving the id).
exception:
  IdInvalidException - if the AssignmentContent id is invalid.
exception:
  IdUsedException - if the AssignmentContent id is already used.
exception:
  PermissionException - if the current user does not have permission to add an AssignnmentContent.



mergeSubmission
public AssignmentSubmissionEdit mergeSubmission(Element el) throws IdInvalidException, IdUsedException, PermissionException(Code)
Add a new AssignmentSubmission to the directory, from a definition in XML. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
  el - The XML DOM Element defining the submission. A locked AssignmentSubmissionEdit object (reserving the id).
exception:
  IdInvalidException - if the submission id is invalid.
exception:
  IdUsedException - if the submission id is already used.
exception:
  PermissionException - if the current user does not have permission to add a submission.



myToolIds
public String[] myToolIds()(Code)



newAssignmentStorage
abstract protected AssignmentStorage newAssignmentStorage()(Code)
Construct a Storage object for Assignments. The new storage object.



newContentStorage
abstract protected AssignmentContentStorage newContentStorage()(Code)
Construct a Storage object for AssignmentContents. The new storage object.



newSubmissionStorage
abstract protected AssignmentSubmissionStorage newSubmissionStorage()(Code)
Construct a Storage object for AssignmentSubmissions. The new storage object.



parseEntityReference
public boolean parseEntityReference(String reference, Reference ref)(Code)



removeAssignment
public void removeAssignment(AssignmentEdit assignment) throws PermissionException(Code)
Removes this Assignment and all references to it.
Parameters:
  assignment - -The Assignment to remove.
throws:
  PermissionException - if current User does not have permission to do this.



removeAssignmentContent
public void removeAssignmentContent(AssignmentContentEdit content) throws AssignmentContentNotEmptyException, PermissionException(Code)
Removes an AssignmentContent
Parameters:
  content - -the AssignmentContent to remove.
throws:
  an - AssignmentContentNotEmptyException if this content still has related Assignments.
throws:
  PermissionException - if current User does not have permission to do this.



removeSubmission
public void removeSubmission(AssignmentSubmissionEdit submission) throws PermissionException(Code)
Removes an AssignmentSubmission and all references to it
Parameters:
  submission - -the AssignmentSubmission to remove.
throws:
  PermissionException - if current User does not have permission to do this.



setAllowGroupAssignments
public void setAllowGroupAssignments(boolean allowGroupAssignments)(Code)
Dependency: allowGroupAssignments
Parameters:
  allowGroupAssignments - the setting



setAllowGroupAssignmentsInGradebook
public void setAllowGroupAssignmentsInGradebook(boolean allowGroupAssignmentsInGradebook)(Code)
Dependency: allowGroupAssignmentsInGradebook
Parameters:
  allowGroupAssignmentsInGradebook -



setCaching
public void setCaching(String value)(Code)
Configuration: set the locks-in-db
Parameters:
  path - The storage path.



setEntityManager
public void setEntityManager(EntityManager service)(Code)
Dependency: EntityManager.
Parameters:
  service - The EntityManager.



setMemoryService
public void setMemoryService(MemoryService service)(Code)
Dependency: MemoryService.
Parameters:
  service - The MemoryService.



setServerConfigurationService
public void setServerConfigurationService(ServerConfigurationService service)(Code)
Dependency: ServerConfigurationService.
Parameters:
  service - The ServerConfigurationService.



submissionId
protected String submissionId(String ref)(Code)
Access the submission id extracted from a submission reference.
Parameters:
  ref - The submission reference string. The the submission id extracted from a submission reference.



submissionReference
public String submissionReference(String context, String id, String assignmentId)(Code)
Access the internal reference which can be used to access the resource from within the system.
Parameters:
  id - The submission id string. The the internal reference which can be used to access the resource from within the system.



submissionsZipReference
public String submissionsZipReference(String context, String assignmentReference)(Code)
Get the string to form an assignment submissions zip file
Parameters:
  context - The assignment context String
Parameters:
  assignmentReference - The reference for the assignment object;



transferCopyEntities
public void transferCopyEntities(String fromContext, String toContext, List resourceIds)(Code)



unlock
protected void unlock(String lock, String resource) throws PermissionException(Code)
Check security permission.
Parameters:
  lock - -The lock id string.
Parameters:
  resource - -The resource reference string, or null if no resource is involved.
exception:
  PermissionException - Thrown if the user does not have access



unlock2
protected void unlock2(String lock1, String lock2, String resource) throws PermissionException(Code)
Check security permission.
Parameters:
  lock1 - The lock id string.
Parameters:
  lock2 - The lock id string.
Parameters:
  resource - The resource reference string, or null if no resource is involved.
exception:
  PermissionException - Thrown if the user does not have access to either.



unlockCheck
protected boolean unlockCheck(String lock, String resource)(Code)
Check security permission.
Parameters:
  lock - -The lock id string.
Parameters:
  resource - -The resource reference string, or null if no resource is involved. true if allowed, false if not



unlockCheck2
protected boolean unlockCheck2(String lock1, String lock2, String resource)(Code)
Check security permission.
Parameters:
  lock1 - The lock id string.
Parameters:
  lock2 - The lock id string.
Parameters:
  resource - The resource reference string, or null if no resource is involved. true if either allowed, false if not



willArchiveMerge
public boolean willArchiveMerge()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.