org.jahia.content

Interface ObjectKeyInterface

All Known Implementing Classes:

CategoryKey, EntryPointObjectKey, ObjectKey

public interface ObjectKeyInterface

Title: Content Object Unique Identifier Key Interface

Description: This interface contains accessor methods to a content object unique identifier key parameters, such as the key itself, the type of the content object, as well as the ID in the type.

Copyright: Copyright (c) 2002

Company:

Version:

1.0

Author:

Serge Huber

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SEPARATOR

Method Summary

Modifier and Type	Method and Description
ObjectKey	getChildInstance(String IDInType, String objectKey) Factory method to create an instance of the corresponding ObjectKey implementation class.
String	getIDInType() Returns a String that represents an identifier for a content object within a type.
String	getKey() Returns the actual key of the content object.
String	getType() Returns a type identifier for a content object.

Field Detail

KEY_SEPARATOR

static final String KEY_SEPARATOR

See Also:

Constant Field Values

Method Detail

getKey

String getKey()

Returns the actual key of the content object. This is a key that is unique within a Jahia installation, regardless of the sites, the pages we are on, etc..

Returns:

a String containing a content object unique key, in the form of something like this : type_IDInType

getType

String getType()

Returns a type identifier for a content object. This can also be thought of as the "class" of the object.

Returns:

a String representing the type identifier of the content object key

getIDInType

String getIDInType()

Returns a String that represents an identifier for a content object within a type. This might also be thought of as the "instance" of the content object of a certain type (or "class").

Returns:

an String representing the identifier within the type of the content object key

getChildInstance

ObjectKey getChildInstance(String IDInType,
                           String objectKey)

Factory method to create an instance of the corresponding ObjectKey implementation class. This is called by the ObjectKey.getInstance() method and should never be called directly.

Parameters:

IDInType - identifier within type

objectKey - the full ObjectKey string representation. This is an optimization to avoid having to rebuild it as when we call this method we already have it.

Returns:

an ObjectKey instance of the appropriate subclass.