com.gentics.contentnode.rest.resource.migration
Interface MigrationResource

All Superinterfaces:
AuthenticatedResource

public interface MigrationResource
extends AuthenticatedResource

Resource used for performing Tag Type Migrations and Template Migrations

Author:
Taylor

Method Summary
 GenericResponse cancelMigration()
          Cancel the current tag type migration job, if one is being executed
 MigrationJobItemsResponse getMigrationJobItems(int jobId)
          Get the migration job items for the given job
 MigrationGetLogResponse getMigrationLog(int jobId)
          Get the log for a given tag type migration job
 MigrationGetLogsResponse getMigrationLogs()
          Get a list of all tag type migration logs
 MigrationStatusResponse getMigrationStatus()
          Get the migration status for a given tag type migration job
 MigrationTagsResponse getMigrationTagTypes(MigrationTagsRequest request)
          Get a list of Tag Types for possible migration by examining the given objects
 MigrationPartsResponse getPartsForTagType(String id)
          Get a list of parts for a single tag type
 PossiblePartMappingsResponse getPossiblePartMappings(int fromTagTypeId, int toTagTypeId)
          Get a response that contains maps and lists with possible part mappings between to both tagtypes
 MigrationResponse performTagTypeMigration(TagTypeMigrationRequest request)
          Perform tag migration process
 MigrationResponse performTemplateMigration(TemplateMigrationRequest request)
           
 MigrationResponse reinvokeTagTypeMigration(MigrationReinvokeRequest request)
          Reinvoke the tag type migration for the given object
 
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
 

Method Detail

cancelMigration

GenericResponse cancelMigration()
Cancel the current tag type migration job, if one is being executed

Returns:
response object containing details about the cancellation

getMigrationStatus

MigrationStatusResponse getMigrationStatus()
Get the migration status for a given tag type migration job

Returns:
response object containing details about the status of the current migration

getMigrationJobItems

MigrationJobItemsResponse getMigrationJobItems(int jobId)
Get the migration job items for the given job

Parameters:
jobId - The jobId for which the items should be loaded
Returns:

getMigrationLogs

MigrationGetLogsResponse getMigrationLogs()
Get a list of all tag type migration logs

Returns:

getMigrationLog

MigrationGetLogResponse getMigrationLog(int jobId)
Get the log for a given tag type migration job

Parameters:
jobId - the id of the migration job
Returns:

performTagTypeMigration

MigrationResponse performTagTypeMigration(TagTypeMigrationRequest request)
Perform tag migration process

Parameters:
request - migration request object
Returns:
response object

performTemplateMigration

MigrationResponse performTemplateMigration(TemplateMigrationRequest request)

reinvokeTagTypeMigration

MigrationResponse reinvokeTagTypeMigration(MigrationReinvokeRequest request)
Reinvoke the tag type migration for the given object

Parameters:
request -
Returns:

getPossiblePartMappings

PossiblePartMappingsResponse getPossiblePartMappings(int fromTagTypeId,
                                                     int toTagTypeId)
Get a response that contains maps and lists with possible part mappings between to both tagtypes

Parameters:
fromTagTypeId - TagTypeId of the tagtype that should be mapped
toTagTypeId - TagTypeId of the desired target tagtype
Returns:
response object

getPartsForTagType

MigrationPartsResponse getPartsForTagType(String id)
Get a list of parts for a single tag type

Parameters:
id - id of the tag type to return tags for
Returns:
response object containing the parts for the requested tag type

getMigrationTagTypes

MigrationTagsResponse getMigrationTagTypes(MigrationTagsRequest request)
Get a list of Tag Types for possible migration by examining the given objects

Parameters:
request - migration tags request object
Returns:
response object containing the tags for the requested objects


Copyright © 2015 Gentics Software GmbH. All Rights Reserved.