co.ecg.alpaca.toolkit.helper.migration

Class MigrationEncumbrances<Source extends BroadWorksObjectInformation,Parent extends BroadWorksObjectInformation>

java.lang.Object

co.ecg.alpaca.toolkit.helper.migration.MigrationEncumbrances<Source,Parent>

Direct Known Subclasses:

GroupMigrationEncumbrances, UserMigrationEncumbrances

public abstract class MigrationEncumbrances<Source extends BroadWorksObjectInformation,Parent extends BroadWorksObjectInformation>
extends Object

The abstract representation of MigrationEncumbrances

Author:

Matthew Keathley on 4/14/16.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log
protected Parent	parent
protected Source	source
protected MigrationType	type

Constructor Summary

Constructors

Constructor and Description
MigrationEncumbrances(Source source, Parent parent, MigrationType type) Creates a new MigrationEncumbrances class for the provided source BroadWorksObjectInformation and the intended migration type.

Method Summary

Modifier and Type	Method and Description
abstract List<EncumbranceError>	checkAllEncumbrances() Method to check the object for all possible encumbrances that prevent migration

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.logging.log4j.Logger log

source

protected Source extends BroadWorksObjectInformation source

parent

protected Parent extends BroadWorksObjectInformation parent

type

protected MigrationType type

Constructor Detail

MigrationEncumbrances

public MigrationEncumbrances(Source source,
                             Parent parent,
                             MigrationType type)

Creates a new MigrationEncumbrances class for the provided source BroadWorksObjectInformation and the intended migration type. e.g. UserInformation for - "2293160001" to MigrationType.User

Parameters:

source - The source object

type - The migration type

Method Detail

checkAllEncumbrances

public abstract List<EncumbranceError> checkAllEncumbrances()
                                                     throws HelperException

Method to check the object for all possible encumbrances that prevent migration

Returns:

The list of Encumbrances

Throws:

HelperException - Thrown if the encumbrance check encounters an unexpected error.