co.ecg.alpaca.toolkit.helper.migration.user

Class UserMigrationRequirements<T extends BroadWorksObjectInformation>

java.lang.Object

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

co.ecg.alpaca.toolkit.helper.migration.user.UserMigrationRequirements<T>

public class UserMigrationRequirements<T extends BroadWorksObjectInformation>
extends MigrationRequirements<UserInformation,T>

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

Author:

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

See Also:

User, Group

Field Summary

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

destination, log, source, type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<RequirementError>	checkAllRequirements() Method to check a User for all possible requirements that prevent migration to the destination.
List<RequirementError>	checkAvailableExtension(GroupInformation groupInformation) Method to check for Group extension availability.
List<RequirementError>	checkDepartmentAvailability(GroupInformation groupInformation) Method to check for Department availability.
List<RequirementError>	checkDomain(GroupInformation groupInformation) Method to check the Domain migration requirement From specification document - The Domain (e.g., "xyz.com") that is applied to the User (at the Profile), and to the User's Identity/Device Profile Line/Port, must exist in the target group.
List<RequirementError>	checkEnterpriseRequirement(GroupInformation groupInformation) Method to check the Inter-Enterprise / Service Provider migration requirement From specification document - The source and destination group must exist within the same Enterprise.
List<RequirementError>	checkFeatureAccessCodeRequirement(GroupInformation destination) Method to check the Feature Access Code requirement.
List<RequirementError>	checkGroupExtensionLength(GroupInformation groupInformation) Method to check for Group extension length From specification document - The Destination Group must have a valid extension length for the User.
List<RequirementError>	checkGroupUserLimit(GroupInformation groupInformation) Method to check for Group user limit.
List<RequirementError>	checkScheduleRequirement(GroupInformation groupInformation) Method to check for Schedule availability in destination Group and Service Provider during User Migration
List<RequirementError>	checkServiceAndServicePackRequirement(GroupInformation groupInformation) Method to check for Services and Service Pack availability in destination Group during User Migration From specification document - Services and Service Packs must exist in the target group.
List<RequirementError>	checkUserVoiceMessagingRequirement(GroupInformation destination) Method to check the User Voice Messaging Requirement.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserMigrationRequirements

public UserMigrationRequirements(UserInformation userInformation,
                                 T destinationInformation,
                                 MigrationType type)

Creates a new UserMigrationRequirements class with the provided UserInformation, DestinationInformation, and Migration Type

Parameters:

userInformation - The UserInformation for the migrating User

destinationInformation - The ObjectInformation for the migration destination

type - The migration type hint

UserMigrationRequirements

public UserMigrationRequirements(UserInformation userInformation,
                                 MigrationType type)

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

Parameters:

userInformation - The UserInformation for the migrating User

type - The migration type

Method Detail

checkAllRequirements

public List<RequirementError> checkAllRequirements()
                                            throws HelperException

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

Specified by:

checkAllRequirements in class MigrationRequirements<UserInformation,T extends BroadWorksObjectInformation>

Returns:

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

Throws:

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

checkAvailableExtension

public List<RequirementError> checkAvailableExtension(GroupInformation groupInformation)

Method to check for Group extension availability. From specification document - The Destination Group must have a the current User extension available.

Returns:

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

checkDepartmentAvailability

public List<RequirementError> checkDepartmentAvailability(GroupInformation groupInformation)

Method to check for Department availability.

Returns:

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

checkDomain

public List<RequirementError> checkDomain(GroupInformation groupInformation)

Method to check the Domain migration requirement From specification document - The Domain (e.g., "xyz.com") that is applied to the User (at the Profile), and to the User's Identity/Device Profile Line/Port, must exist in the target group.

Returns:

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

checkEnterpriseRequirement

public List<RequirementError> checkEnterpriseRequirement(GroupInformation groupInformation)

Method to check the Inter-Enterprise / Service Provider migration requirement From specification document - The source and destination group must exist within the same Enterprise.

Returns:

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

checkGroupExtensionLength

public List<RequirementError> checkGroupExtensionLength(GroupInformation groupInformation)

Method to check for Group extension length From specification document - The Destination Group must have a valid extension length for the User.

Returns:

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

checkGroupUserLimit

public List<RequirementError> checkGroupUserLimit(GroupInformation groupInformation)

Method to check for Group user limit. From specification document - The Destination Group must have sufficient user availability to perform the move.

Returns:

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

checkScheduleRequirement

public List<RequirementError> checkScheduleRequirement(GroupInformation groupInformation)

Method to check for Schedule availability in destination Group and Service Provider during User Migration

From specification document - If the User is using a Group or Service Provider schedule, and the Destination Group or Service Provider does not have a Group or Service Provider Schedule of the same name, the User is not moved.

Returns:

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

checkServiceAndServicePackRequirement

public List<RequirementError> checkServiceAndServicePackRequirement(GroupInformation groupInformation)

Method to check for Services and Service Pack availability in destination Group during User Migration From specification document - Services and Service Packs must exist in the target group.

Returns:

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

checkUserVoiceMessagingRequirement

public List<RequirementError> checkUserVoiceMessagingRequirement(GroupInformation destination)

Method to check the User Voice Messaging Requirement. If a User has the Voice Messaging User service assigned, either the Destination Group has to have Voice Messaging Group assigned or a System Voice Portal must exist otherwise the migration is not valid.

UserVoiceMessaging - [Error 5437] Greetings are not available. Voice Messaging User must be assigned to the user and either Voice Messaging Group is assigned to the users Group or there is at least one System Voice Portal in the system. UserVoiceMessaging - [Error 5435] Voice Management are not available. Voice Messaging User must be assigned to the user and either Voice Messaging Group is assigned to the users Group or there is at least one System Voice Portal in the system.

Parameters:

destination - The destination information object.

Returns:

the list of RequirementErrors.

checkFeatureAccessCodeRequirement

public List<RequirementError> checkFeatureAccessCodeRequirement(GroupInformation destination)

Method to check the Feature Access Code requirement. If a User's source Group has a Service assigned that adds extra Feature Access Codes, then the Destination Group must also have the service assigned to prevent loss of data.

Account/Authorization Codes - Per Call Account Code - Per-Call Account Code

Hunt Group - Hunt Group Busy Activation - Hunt Group Busy Deactivation - Hunt Group Busy Interrogation

Call Park - Call Park - Call Park Retrieve - Group Call Park

Call Pickup - Call Pickup

Enhanced Outgoing Calling Plan - Sustained Authorization Code Activation (calls unlocking) - EOCP Sustained Authorization Code Unlock - Sustained Authorization Code Deactivation (calls locking) - EOCP Sustained Authorization Code Lock

Find-me/Follow-me - Find-me/Follow-me Call Push - FMFM Call Push

Music On Hold - Music On Hold Per-Call Deactivation

Parameters:

destination - The destination information object.

Returns:

the list of RequirementErrors.