Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 0b534706462160dd64f87ed28c30e81b5d174792 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*****************************************************************************
 * Copyright (c) 2016 Christian W. Damus and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Christian W. Damus - Initial API and implementation
 *   
 *****************************************************************************/

package org.eclipse.papyrus.infra.services.controlmode.participants;

import org.eclipse.gmf.runtime.common.core.command.ICommand;
import org.eclipse.papyrus.infra.services.controlmode.ControlModeRequest;

/**
 * An optional participant protocol for contribution of ancillary changes
 * when the 'shard' mode of a sub-unit resource is changed.
 * 
 * @since 1.3
 */
public interface IShardModeCommandParticipant extends IControlModeParticipant {

	/**
	 * Queries whether I participate in processing of the given {@code request}.
	 *
	 * @param request
	 *            a request, which will always be a
	 *            {@link ControlModeRequest#isControlRequest() control} request by
	 *            by default because it simply changes the sub-unit structure between
	 *            'sub-model' and 'shard' unit type
	 * 
	 * @return whether I should be asked for commands to participate in the
	 *         shard conversion operation
	 */
	boolean providesShardModeCommand(ControlModeRequest request);

	/**
	 * Obtains a command to execute before the basic conversion of the
	 * 'shard' mode is performed.
	 *
	 * @param request
	 *            a request, which will always be a
	 *            {@link ControlModeRequest#isControlRequest() control} request by
	 *            by default because it simply changes the sub-unit structure between
	 *            'sub-model' and 'shard' unit type
	 * 
	 * @return a command, or {@code null} if none is needed
	 */
	default ICommand getPreShardModeCommand(ControlModeRequest request) {
		return null;
	}

	/**
	 * Obtains a command to execute after the basic conversion of the
	 * 'shard' mode is performed.
	 *
	 * @param request
	 *            a request, which will always be a
	 *            {@link ControlModeRequest#isControlRequest() control} request by
	 *            by default because it simply changes the sub-unit structure between
	 *            'sub-model' and 'shard' unit type
	 * 
	 * @return a command, or {@code null} if none is needed
	 */
	default ICommand getPostShardModeCommand(ControlModeRequest request) {
		return null;
	}
}

Back to the top