edu.ksu.canvas.requestOptions

Class CreateContentMigrationOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.CreateContentMigrationOptions

Direct Known Subclasses:

CreateCourseContentMigrationOptions

public class CreateContentMigrationOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateContentMigrationOptions.MigrationType

Field Summary

Fields

Modifier and Type	Field and Description
protected CreateContentMigrationOptions.MigrationType	migrationType
protected String	sourceCourseId

Fields inherited from class edu.ksu.canvas.requestOptions.BaseOptions

optionsMap

Constructor Summary

Constructors

Constructor and Description
CreateContentMigrationOptions(String sourceCourseId, CreateContentMigrationOptions.MigrationType migrationType) Constructs object to hold API options for the creating a content migration.

Method Summary

Modifier and Type	Method and Description
CreateContentMigrationOptions	addFileUploadProperty(String name, String value)
CreateContentMigrationOptions	contentExport(String contentExportId)
CreateContentMigrationOptions	fileUrl(String fileUrl)
CreateContentMigrationOptions	folder(String folderId)
CreateContentMigrationOptions.MigrationType	getMigrationType()
String	getSourceCourseId()
CreateContentMigrationOptions	preAttachment(String name)

Methods inherited from class edu.ksu.canvas.requestOptions.BaseOptions

addEnumList, addNumberList, addSingleItem, addStringList, getOptionsMap

Methods inherited from class java.lang.Object

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

Field Detail

sourceCourseId

protected final String sourceCourseId

migrationType

protected final CreateContentMigrationOptions.MigrationType migrationType

Constructor Detail

CreateContentMigrationOptions

public CreateContentMigrationOptions(String sourceCourseId,
                                     CreateContentMigrationOptions.MigrationType migrationType)

Constructs object to hold API options for the creating a content migration. A course content migration has its own options class, see CreateCourseContentMigrationOptions.

Parameters:

sourceCourseId - The id of the source course

migrationType - Migration type, see enum options

Method Detail

getSourceCourseId

public String getSourceCourseId()

getMigrationType

public CreateContentMigrationOptions.MigrationType getMigrationType()

preAttachment

public CreateContentMigrationOptions preAttachment(String name)

addFileUploadProperty

public CreateContentMigrationOptions addFileUploadProperty(String name,
                                                           String value)

fileUrl

public CreateContentMigrationOptions fileUrl(String fileUrl)

contentExport

public CreateContentMigrationOptions contentExport(String contentExportId)

folder

public CreateContentMigrationOptions folder(String folderId)