KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jahia > content > ObjectKeyInterface


1 package org.jahia.content;
2
3 /**
4  * <p>Title: Content Object Unique Identifier Key Interface</p>
5  * <p>Description: This interface contains accessor methods to a content object
6  * unique identifier key parameters, such as the key itself, the type of the
7  * content object, as well as the ID in the type.</p>
8  * <p>Copyright: Copyright (c) 2002</p>
9  * <p>Company: </p>
10  * @author Serge Huber
11  * @version 1.0
12  */

13
14 public interface ObjectKeyInterface {
15
16     static final String JavaDoc KEY_SEPARATOR = "_";
17
18     /**
19      * Returns the actual key of the content object. This is a key that is
20      * unique within a Jahia installation, regardless of the sites, the pages
21      * we are on, etc..
22      * @return a String containing a content object unique key, in the form
23      * of something like this : type_IDInType
24      */

25     public String JavaDoc getKey();
26
27     /**
28      * Returns a type identifier for a content object. This can also be thought
29      * of as the "class" of the object.
30      * @return a String representing the type identifier of the content object
31      * key
32      */

33     public String JavaDoc getType();
34
35     /**
36      * Returns a String that represents an identifier for a content object
37      * within a type. This might also be thought of as the "instance" of the
38      * content object of a certain type (or "class").
39      * @return an String representing the identifier within the type of the
40      * content object key
41      */

42     public String JavaDoc getIDInType();
43 }
Popular Tags