co.ecg.alpaca.toolkit.helper.migration.group

Class GroupMigrationRequirements<T extends BroadWorksObjectInformation>

java.lang.Object

co.ecg.alpaca.toolkit.helper.migration.MigrationRequirements<GroupInformation,T>

co.ecg.alpaca.toolkit.helper.migration.group.GroupMigrationRequirements<T>

public class GroupMigrationRequirements<T extends BroadWorksObjectInformation>
extends MigrationRequirements<GroupInformation,T>

The GroupMigrationRequirements class houses all requirement checks for a Group to have a valid migration target. These are distinct from Encumbrances in that they check issues with the destination BroadWorksObject rather than the Group alone.

Author:

Matthew Keathley - mkeathley@e-c-group.com

See Also:

User, Group, BroadWorksObject

Field Summary

Fields inherited from class co.ecg.alpaca.toolkit.helper.migration.MigrationRequirements

destination, log, source, type

Constructor Summary

Constructors

Constructor and Description
GroupMigrationRequirements(GroupInformation information, MigrationType type) Creates a new GroupMigrationRequirements class with the provided UserInformation and Migration Type.
GroupMigrationRequirements(GroupInformation information, T destinationInformation, MigrationType type) Creates a new GroupMigrationRequirements class with the provided GroupInformation, DestinationInformation, and Migration Type

Method Summary

Modifier and Type	Method and Description
List<RequirementError>	checkAllRequirements() Method to check a Group for all possible requirements that prevent migration to the destination.
List<RequirementError>	checkUserRequirements() Method to check the User requirements If an of the User's within the Group have limiting requirements from this migration type then the Group also has requirements.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupMigrationRequirements

public GroupMigrationRequirements(GroupInformation information,
                                  T destinationInformation,
                                  MigrationType type)
                           throws HelperException

Creates a new GroupMigrationRequirements class with the provided GroupInformation, DestinationInformation, and Migration Type

Parameters:

information - The GroupInformation for the migrating Group

destinationInformation - The ObjectInformation for the migration destination

type - The migration type hint

Throws:

HelperException

GroupMigrationRequirements

public GroupMigrationRequirements(GroupInformation information,
                                  MigrationType type)
                           throws HelperException

Creates a new GroupMigrationRequirements class with the provided UserInformation and Migration Type.

Parameters:

information - The GroupInformation for the migrating Group

type - The migration type

Throws:

HelperException

Method Detail

checkAllRequirements

public List<RequirementError> checkAllRequirements()
                                            throws HelperException

Method to check a Group for all possible requirements that prevent migration to the destination.

Specified by:

checkAllRequirements in class MigrationRequirements<GroupInformation,T extends BroadWorksObjectInformation>

Returns:

The list of RequirementError objects. The list will be empty for valid migration target.

Throws:

HelperException

checkUserRequirements

public List<RequirementError> checkUserRequirements()

Method to check the User requirements If an of the User's within the Group have limiting requirements from this migration type then the Group also has requirements.

Returns:

The list of requirements