PostemTool (Sakai Postem Tool 10.3 API)

java.lang.Object
- org.sakaiproject.tool.postem.PostemTool

```
public class PostemTool
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`ascending`
`protected int`	`column`
`protected String`	`csv`
`protected org.sakaiproject.api.app.postem.data.Gradebook`	`currentGradebook`
`protected org.sakaiproject.api.app.postem.data.StudentGrades`	`currentStudent`
`protected String`	`delimiter`
`protected boolean`	`displayErrors`
`protected String`	`filename`
`protected org.sakaiproject.api.app.postem.data.GradebookManager`	`gradebookManager`
`protected ArrayList`	`gradebooks`
`protected boolean`	`gradebooksExist`
`protected UIData`	`gradebookTable`
`static String`	`messageBundle`
`org.sakaiproject.util.ResourceLoader`	`msgs`
`protected String`	`newTemplate`
`protected org.sakaiproject.api.app.postem.data.Gradebook`	`oldGradebook`
`protected String`	`selectedStudent`
`protected String`	`siteId`
`protected String`	`sortBy`
`protected TreeMap`	`studentMap`
`protected ArrayList`	`students`
`protected String`	`title`
`protected String`	`userEid`
`protected String`	`userId`
`protected boolean`	`userPressedBack`
`protected boolean`	`withHeader`

Constructor Summary

Constructors
Constructor and Description

PostemTool()

Constructors
Constructor and Description
`PostemTool()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`checkAccess()`
`protected static void`	`clearMessages()`
`org.sakaiproject.entity.api.Reference`	`getAttachmentReference()`
`String`	`getAttachmentTitle()`
`int`	`getColumn()`
`String`	`getCsv()`
`Column`	`getCurrentColumn()`
`org.sakaiproject.api.app.postem.data.Gradebook`	`getCurrentGradebook()`
`String`	`getCurrentRediredUrl()`
`String`	`getCurrentStudentGrades()`
`String`	`getDelimiter()`
`boolean`	`getDisplayErrors()`
`String`	`getFirstStudentGrades()`
`org.sakaiproject.api.app.postem.data.GradebookManager`	`getGradebookManager()`
`ArrayList`	`getGradebooks()`
`boolean`	`getGradebooksExist()`
`UIData`	`getGradebookTable()`
`String`	`getNewTemplate()`
`String`	`getReferenceTitle(org.sakaiproject.entity.api.Reference ref)`
`String`	`getSelectedStudent()`
`String`	`getSelectedStudentGrades()`
`Map`	`getStatsColumns()`
`TreeMap`	`getStudentMap()`
`ArrayList`	`getStudents()`
`String`	`getTitle()`
`boolean`	`getWithHeader()`
`boolean`	`isAscending()`
`boolean`	`isCreatorSort()`
`boolean`	`isEditable()`
`boolean`	`isModBySort()`
`boolean`	`isModDateSort()`
`boolean`	`isReleasedSort()`
`boolean`	`isTitleSort()`
`static void`	`populateMessage(FacesMessage.Severity severity, String messageId, Object[] args)`
`String`	`processAddAttachRedirect()`
`String`	`processCancelNew()`
`String`	`processCancelView()`
`String`	`processCreate()`
`String`	`processCreateBack()`
`String`	`processCreateNew()`
`String`	`processCreateOk()`
`String`	`processCsvDownload()`
`String`	`processDelete()`
`String`	`processGradebookDelete()`
`String`	`processGradebookUpdate()`
`String`	`processGradebookView()`
`String`	`processInstructorView()`
`String`	`processTemplateDownload()`
`void`	`setAttachment(org.sakaiproject.entity.api.Reference attachment)`
`void`	`setColumn(int column)`
`void`	`setContentHostingService(org.sakaiproject.content.api.ContentHostingService contentHostingService)`
`void`	`setCsv(String csv)`
`void`	`setCurrentGradebook(org.sakaiproject.api.app.postem.data.Gradebook currentGradebook)`
`void`	`setCurrentRediredUrl(String currentRediredUrl)`
`void`	`setDelimiter(String delimiter)`
`void`	`setDisplayErrors(boolean displayErrors)`
`void`	`setGradebookManager(org.sakaiproject.api.app.postem.data.GradebookManager gradebookManager)`
`void`	`setGradebookTable(UIData gradebookTable)`
`void`	`setNewTemplate(String newTemplate)`
`void`	`setSelectedStudent(String selectedStudent)`
`void`	`setWithHeader(boolean withHeader)`
`String`	`toggleCreatorSort()`
`String`	`toggleModBySort()`
`String`	`toggleModDateSort()`
`String`	`toggleReleasedSort()`
`void`	`toggleSort(String sortByType)`
`String`	`toggleTitleSort()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

gradebookManager

protected org.sakaiproject.api.app.postem.data.GradebookManager gradebookManager

gradebooks
```
protected ArrayList gradebooks
```

currentGradebook

protected org.sakaiproject.api.app.postem.data.Gradebook currentGradebook

studentMap
```
protected TreeMap studentMap
```

oldGradebook

protected org.sakaiproject.api.app.postem.data.Gradebook oldGradebook

userId
```
protected String userId
```

userEid
```
protected String userEid
```

filename
```
protected String filename
```

csv
```
protected String csv
```

siteId
```
protected String siteId
```

gradebookTable
```
protected UIData gradebookTable
```

title
```
protected String title
```

newTemplate
```
protected String newTemplate
```

students
```
protected ArrayList students
```

delimiter
```
protected String delimiter
```

ascending
```
protected boolean ascending
```

sortBy
```
protected String sortBy
```

displayErrors
```
protected boolean displayErrors
```

userPressedBack
```
protected boolean userPressedBack
```

gradebooksExist
```
protected boolean gradebooksExist
```

currentStudent

protected org.sakaiproject.api.app.postem.data.StudentGrades currentStudent

selectedStudent
```
protected String selectedStudent
```

withHeader
```
protected boolean withHeader
```

column
```
protected int column
```

messageBundle

public static final String messageBundle

See Also:: Constant Field Values

msgs

public org.sakaiproject.util.ResourceLoader msgs

Constructor Detail
- PostemTool
```
public PostemTool()
```

Method Detail

getColumn
```
public int getColumn()
```

setColumn
```
public void setColumn(int column)
```

getGradebooks
```
public ArrayList getGradebooks()
```

getGradebooksExist
```
public boolean getGradebooksExist()
```

getCsv
```
public String getCsv()
```

setCsv
```
public void setCsv(String csv)
```

getDelimiter
```
public String getDelimiter()
```

setDelimiter

public void setDelimiter(String delimiter)

getNewTemplate
```
public String getNewTemplate()
```

setNewTemplate

public void setNewTemplate(String newTemplate)

getGradebookManager

public org.sakaiproject.api.app.postem.data.GradebookManager getGradebookManager()

setGradebookManager

public void setGradebookManager(org.sakaiproject.api.app.postem.data.GradebookManager gradebookManager)

setContentHostingService

public void setContentHostingService(org.sakaiproject.content.api.ContentHostingService contentHostingService)

getGradebookTable
```
public UIData getGradebookTable()
```

setGradebookTable

public void setGradebookTable(UIData gradebookTable)

getCurrentGradebook

public org.sakaiproject.api.app.postem.data.Gradebook getCurrentGradebook()

setCurrentGradebook

public void setCurrentGradebook(org.sakaiproject.api.app.postem.data.Gradebook currentGradebook)

getSelectedStudent
```
public String getSelectedStudent()
```

setSelectedStudent

public void setSelectedStudent(String selectedStudent)

getWithHeader
```
public boolean getWithHeader()
```

setWithHeader

public void setWithHeader(boolean withHeader)

getDisplayErrors
```
public boolean getDisplayErrors()
```

getStudentMap
```
public TreeMap getStudentMap()
```

setDisplayErrors

public void setDisplayErrors(boolean displayErrors)

getCurrentStudentGrades

public String getCurrentStudentGrades()

getFirstStudentGrades
```
public String getFirstStudentGrades()
```

getSelectedStudentGrades

public String getSelectedStudentGrades()

toggleSort

public void toggleSort(String sortByType)

toggleTitleSort
```
public String toggleTitleSort()
```

toggleCreatorSort
```
public String toggleCreatorSort()
```

toggleModBySort
```
public String toggleModBySort()
```

toggleModDateSort
```
public String toggleModDateSort()
```

toggleReleasedSort
```
public String toggleReleasedSort()
```

isTitleSort
```
public boolean isTitleSort()
```

isCreatorSort
```
public boolean isCreatorSort()
```

isModBySort
```
public boolean isModBySort()
```

isModDateSort
```
public boolean isModDateSort()
```

isReleasedSort
```
public boolean isReleasedSort()
```

isAscending
```
public boolean isAscending()
```

processCreateNew
```
public String processCreateNew()
```

processGradebookUpdate

public String processGradebookUpdate()

populateMessage

public static void populateMessage(FacesMessage.Severity severity,
                   String messageId,
                   Object[] args)

clearMessages
```
protected static void clearMessages()
```

processCreate
```
public String processCreate()
```

processCreateOk
```
public String processCreateOk()
```

processCreateBack
```
public String processCreateBack()
```

processCancelNew
```
public String processCancelNew()
```

processCancelView
```
public String processCancelView()
```

processGradebookView
```
public String processGradebookView()
```

processInstructorView
```
public String processInstructorView()
```

processGradebookDelete

public String processGradebookDelete()

processDelete
```
public String processDelete()
```

processCsvDownload
```
public String processCsvDownload()
```

processTemplateDownload

public String processTemplateDownload()

getStudents
```
public ArrayList getStudents()
```

getTitle
```
public String getTitle()
```

isEditable
```
public boolean isEditable()
```

checkAccess
```
public boolean checkAccess()
```

getStatsColumns
```
public Map getStatsColumns()
```

getCurrentColumn
```
public Column getCurrentColumn()
```

processAddAttachRedirect

public String processAddAttachRedirect()

getCurrentRediredUrl
```
public String getCurrentRediredUrl()
```

setCurrentRediredUrl

public void setCurrentRediredUrl(String currentRediredUrl)

getAttachmentReference

public org.sakaiproject.entity.api.Reference getAttachmentReference()

getAttachmentTitle
```
public String getAttachmentTitle()
```

setAttachment

public void setAttachment(org.sakaiproject.entity.api.Reference attachment)

getReferenceTitle

public String getReferenceTitle(org.sakaiproject.entity.api.Reference ref)

Class PostemTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

gradebookManager

gradebooks

currentGradebook

studentMap

oldGradebook

userId

userEid

filename

csv

siteId

gradebookTable

title

newTemplate

students

delimiter

ascending

sortBy

displayErrors

userPressedBack

gradebooksExist

currentStudent

selectedStudent

withHeader

column

messageBundle

msgs

Constructor Detail

PostemTool

Method Detail

getColumn

setColumn

getGradebooks

getGradebooksExist

getCsv

setCsv

getDelimiter

setDelimiter

getNewTemplate

setNewTemplate

getGradebookManager

setGradebookManager

setContentHostingService

getGradebookTable

setGradebookTable

getCurrentGradebook

setCurrentGradebook

getSelectedStudent

setSelectedStudent

getWithHeader

setWithHeader

getDisplayErrors

getStudentMap

setDisplayErrors

getCurrentStudentGrades

getFirstStudentGrades

getSelectedStudentGrades

toggleSort

toggleTitleSort

toggleCreatorSort

toggleModBySort

toggleModDateSort

toggleReleasedSort

isTitleSort

isCreatorSort

isModBySort

isModDateSort

isReleasedSort

isAscending

processCreateNew

processGradebookUpdate

populateMessage

clearMessages

processCreate

processCreateOk