aboutsummaryrefslogtreecommitdiffstats
path: root/policy-core/src/main/java/org/openecomp/policy/drools/properties/Startable.java
blob: bb6334a204eb28eb182ef4208fe4f08e6ffa91b0 (plain)
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
/*-
 * ============LICENSE_START=======================================================
 * policy-core
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.policy.drools.properties;

/**
 * Declares the Startable property of any class class implementing
 * this interface.   This implies that the implementing class supports
 * start-like operations.
 */
public interface Startable {
	
	/**
	 * Start operation.  This operation starts the entity.
	 * 
	 * @return boolean.  true if the start operation was successful, 
	 * otherwise false.
	 * @throws IllegalStateException. if the element is in a state that
	 * conflicts with the start operation.
	 */
	public boolean start() throws IllegalStateException;
	
	/**
	 * Stop operation.  The entity can be restarted again by invoking
	 * the start operation.
	 * 
	 * @return boolean.  true if the stop operation was successful, 
	 * otherwise false.
	 * @throws IllegalStateException. if the element is in a state that
	 * conflicts with the stop operation.
	 */
	public boolean stop()throws IllegalStateException;
	
	/**
	 * shutdown operation.   The terminate operation yields the entity
	 * unusuable.  It cannot be (re)started.
	 * 
	 * @throws IllegalStateException. if the element is in a state that
	 * conflicts with the stop operation.
	 */
	public void shutdown()throws IllegalStateException;
	
	/**
	 * is it alive?
	 * @return boolean.  true if alive, otherwise false
	 */
	public boolean isAlive();
}