GetTargetedOperationContext.java

/**
 * Copyright (c) 2004-2025 Carnegie Mellon University and others. (see Contributors file).
 * All Rights Reserved.
 *
 * NO WARRANTY. ALL MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY
 * KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE
 * OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT
 * MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * SPDX-License-Identifier: EPL-2.0
 *
 * Created, in part, with funding and support from the United States Government. (see Acknowledgments file).
 *
 * This program includes and/or can make use of certain third party source code, object code, documentation and other
 * files ("Third Party Software"). The Third Party Software that is used by this program is dependent upon your system
 * configuration. By using this program, You agree to comply with any and all relevant Third Party Software terms and
 * conditions contained in any such Third Party Software or separate license file distributed with such Third Party
 * Software. The parties who own the Third Party Software ("Third Party Licensors") are intended third party benefici-
 * aries to this license with respect to the terms applicable to their Third Party Software. Third Party Software li-
 * censes only apply to the Third Party Software and not any other portion of this program or this program as a whole.
 */
package org.osate.ge.palette;

import java.util.Objects;

import org.osate.ge.BusinessObjectContext;
import org.osate.ge.DockingPosition;
import org.osate.ge.services.QueryService;

/**
 * Contains information provided to targeted palette commands.
 * @noextend This class is not intended to be subclassed by clients.
 * @since 2.0
 */
public final class GetTargetedOperationContext {
	private final BusinessObjectContext targetBoc;
	private final DockingPosition dockingPostion;
	private final QueryService queryService;

	/**
	 * Creates a new instance.
	 * @param targetBoc is the target for the command.
	 * @param dockingPostion is the most appropriate DockingPosition based on the location at which the command was activated is being created.
	 * @param queryService is a query service instance to provide to the palette command.
	 */
	public GetTargetedOperationContext(final BusinessObjectContext targetBoc, final DockingPosition dockingPostion,
			final QueryService queryService) {
		this.targetBoc = Objects.requireNonNull(targetBoc, "targetBoc must not be null");
		this.dockingPostion = Objects.requireNonNull(dockingPostion,
				"targetDockingPosition must not be null");
		this.queryService = Objects.requireNonNull(queryService, "queryService must not be null");
	}

	/**
	 * Returns the business object context based on the location at which the command is being activated.
	 * @return the business object context in which the command is being activated.
	 */
	public final BusinessObjectContext getTarget() {
		return targetBoc;
	}

	/**
	 * Return the docking position based on the location at which the command is being activated.
	 * @return the docking position
	 */
	public final DockingPosition getDockingPosition() {
		return dockingPostion;
	}

	/**
	 * Returns the query service
	 * @return the query service
	 */
	public final QueryService getQueryService() {
		return queryService;
	}
}