edu.ksu.canvas.model

Class ExternalTool

java.lang.Object

edu.ksu.canvas.model.BaseCanvasModel

edu.ksu.canvas.model.ExternalTool

All Implemented Interfaces:

Serializable

public class ExternalTool
extends BaseCanvasModel
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExternalTool()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAccountNavigation()
String	getConfigType()
String	getConfigUrl()
String	getConfigXml()
String	getConsumerKey()
Map<String,Object>	getCourseNavigation()
Date	getCreatedAt()
Map<String,String>	getCustomFields() A map of Canvas specific custom fields that will be added to the LTI launch request.
String	getDescription()
String	getDomain()
Map<String,Object>	getEditorButton()
String	getIconUrl()
Integer	getId()
String	getName()
Boolean	getNotSelectable()
String	getPrivacyLevel()
Map<String,Object>	getResourceSelection()
String	getSharedSecret()
String	getText()
Date	getUpdatedAt()
String	getUrl()
Map<String,Object>	getUserNavigation()
String	getVersion() The LTI version that this tool uses.
String	getWorkflowState()
void	setAccountNavigation(Map<String,Object> accountNavigation)
void	setConfigType(String configType)
void	setConfigUrl(String configUrl)
void	setConfigXml(String configXml)
void	setConsumerKey(String consumerKey)
void	setCourseNavigation(Map<String,Object> courseNavigation)
void	setCreatedAt(Date createdAt)
void	setCustomFields(Map<String,String> customFields)
void	setDescription(String description)
void	setDomain(String domain)
void	setEditorButton(Map<String,Object> editorButton)
void	setIconUrl(String iconUrl)
void	setId(Integer id)
void	setName(String name)
void	setNotSelectable(Boolean notSelectable)
void	setPrivacyLevel(String privacyLevel)
void	setResourceSelection(Map<String,Object> resourceSelection)
void	setSharedSecret(String sharedSecret)
void	setText(String text)
void	setUpdatedAt(Date updatedAt)
void	setUrl(String url)
void	setUserNavigation(Map<String,Object> userNavigation)
void	setVersion(String version)
void	setWorkflowState(String workflowState)

Methods inherited from class edu.ksu.canvas.model.BaseCanvasModel

toJsonObject, toPostMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalTool

public ExternalTool()

Method Detail

getId

public Integer getId()

setId

public void setId(Integer id)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getDomain

public String getDomain()

setDomain

public void setDomain(String domain)

getPrivacyLevel

public String getPrivacyLevel()

setPrivacyLevel

public void setPrivacyLevel(String privacyLevel)

getConsumerKey

public String getConsumerKey()

setConsumerKey

public void setConsumerKey(String consumerKey)

getSharedSecret

public String getSharedSecret()

setSharedSecret

public void setSharedSecret(String sharedSecret)

getCreatedAt

public Date getCreatedAt()

setCreatedAt

public void setCreatedAt(Date createdAt)

getUpdatedAt

public Date getUpdatedAt()

setUpdatedAt

public void setUpdatedAt(Date updatedAt)

getWorkflowState

public String getWorkflowState()

setWorkflowState

public void setWorkflowState(String workflowState)

getIconUrl

public String getIconUrl()

setIconUrl

public void setIconUrl(String iconUrl)

getText

public String getText()

setText

public void setText(String text)

getNotSelectable

public Boolean getNotSelectable()

setNotSelectable

public void setNotSelectable(Boolean notSelectable)

getConfigType

public String getConfigType()

setConfigType

public void setConfigType(String configType)

getConfigXml

public String getConfigXml()

setConfigXml

public void setConfigXml(String configXml)

getConfigUrl

public String getConfigUrl()

setConfigUrl

public void setConfigUrl(String configUrl)

getVersion

public String getVersion()

The LTI version that this tool uses. Example values: 1.1, 1.3 This field is not documented in the Canvas API docs

Returns:

LTI version used by this tool

setVersion

public void setVersion(String version)

getCustomFields

public Map<String,String> getCustomFields()

A map of Canvas specific custom fields that will be added to the LTI launch request. See Variable Subsitution docs

Returns:

Map of custom variables configured for this tool

setCustomFields

public void setCustomFields(Map<String,String> customFields)

getAccountNavigation

public Map<String,Object> getAccountNavigation()

setAccountNavigation

public void setAccountNavigation(Map<String,Object> accountNavigation)

getUserNavigation

public Map<String,Object> getUserNavigation()

setUserNavigation

public void setUserNavigation(Map<String,Object> userNavigation)

getCourseNavigation

public Map<String,Object> getCourseNavigation()

setCourseNavigation

public void setCourseNavigation(Map<String,Object> courseNavigation)

getEditorButton

public Map<String,Object> getEditorButton()

setEditorButton

public void setEditorButton(Map<String,Object> editorButton)

getResourceSelection

public Map<String,Object> getResourceSelection()

setResourceSelection

public void setResourceSelection(Map<String,Object> resourceSelection)