1	<?php declare(strict_types = 1);
2	/*
3	* Copyright (c) 2012-2019, Josef Kufner  <josef@kufner.cz>
4	*
5	* Licensed under the Apache License, Version 2.0 (the "License");
6	* you may not use this file except in compliance with the License.
7	* You may obtain a copy of the License at
8	*
9	*     http://www.apache.org/licenses/LICENSE-2.0
10	*
11	* Unless required by applicable law or agreed to in writing, software
12	* distributed under the License is distributed on an "AS IS" BASIS,
13	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14	* See the License for the specific language governing permissions and
15	* limitations under the License.
16	*
17	*/
18
19	namespace Smalldb\StateMachine;
20
21	use Smalldb\StateMachine\Annotation\State;
22	use Smalldb\StateMachine\Definition\StateMachineDefinition;
23	use Smalldb\StateMachine\Transition\TransitionEvent;
24
25
26	interface ReferenceInterface extends MachineIdentifierInterface
27	{
28	/**
29	* @State
30	*/
31	const NOT_EXISTS = "";
32
33	/**
34	* Invalidate cached data.
35	*
36	* TODO: Remove invalidateCache() and implement proper locking before invoking a transition.
37	*
38	* @internal
39	* @deprecated
40	*/
41	public function invalidateCache(): void;
42
43	/**
44	* Read state machine state
45	*/
46	public function getState(): string;
47
48	/**
49	* Get state machine definition
50	*/
51	public function getDefinition(): StateMachineDefinition;
52
53	/**
54	* Return true when the transition is available.
55	*/
56	public function isTransitionAllowed(string $transitionName): bool;
57
58	/**
59	* Invoke transition of the state machine.
60	*/
61	public function invokeTransition(string $transitionName, ...$args): TransitionEvent;
62
63	/**
64	* Return value of the given property.
65	*/
66	public function get(string $propertyName);
67
68	}