aboutsummaryrefslogtreecommitdiffstats
path: root/capabilities/src/main/java/org/onap/policy/common/capabilities/Lockable.java
blob: cc9da0a90f89fc0a11f9cc98ef8f70411d239245 (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
/*-
 * ============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.onap.policy.common.capabilities;

/**
 * Interface for classes that supports lock/unlock operations.
 */
public interface Lockable {

    /**
     * Locks this entity.
     * 
     * @return true is the lock operation was successful, false otherwise
     */
    public boolean lock();

    /**
     * Unlocks this entity.
     * 
     * @return true is the unlock operation was successful, false otherwise
     */
    public boolean unlock();

    /**
     * Checks if this entity is locked.
     * 
     * @return true if the entity is in a locked state, false otherwise
     */
    public boolean isLocked();
}