1 /**
2 * Copyright (C) 2014-2015 Philip Helger (www.helger.com)
3 * philip[at]helger[dot]com
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 package com.helger.schematron.pure.model;
18
19 import javax.annotation.Nullable;
20
21 /**
22 * Base interface for all elements that may have an ID.
23 * <code>IHasID<String></code> is not used here, because it requires an ID
24 * to be present!
25 *
26 * @author Philip Helger
27 */
28 public interface IPSHasID
29 {
30 /**
31 * Set an ID for this object.
32 *
33 * @param sID
34 * The ID to be set. May be <code>null</code>.
35 */
36 void setID (@Nullable String sID);
37
38 /**
39 * @return <code>true</code> if an ID is present, <code>false</code>
40 * otherwise.
41 */
42 boolean hasID ();
43
44 /**
45 * @return The optional ID of this element. May be <code>null</code>.
46 */
47 @Nullable
48 String getID ();
49 }