org.craftercms.engine.targeting.impl

Class AbstractTargetIdManager

java.lang.Object

org.craftercms.engine.targeting.impl.AbstractTargetIdManager

All Implemented Interfaces:

TargetIdManager

Direct Known Subclasses:

LocaleTargetIdManager

public abstract class AbstractTargetIdManager
extends Object
implements TargetIdManager

TargetIdManager base class, that provides basic implementations of getFallbackTargetId() and getAvailableTargetIds().

Author:

avasquez

Constructor Summary

Constructors

Constructor and Description
AbstractTargetIdManager()

Method Summary

Modifier and Type	Method and Description
List<String>	getAvailableTargetIds() Returns the available target IDs defined in the current site configuration.
String	getFallbackTargetId() Returns the fallback ID defined in the current site configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.craftercms.engine.targeting.TargetIdManager

getCurrentTargetId

Constructor Detail

AbstractTargetIdManager

public AbstractTargetIdManager()

Method Detail

getFallbackTargetId

public String getFallbackTargetId()
                           throws IllegalStateException

Returns the fallback ID defined in the current site configuration. If not defined, null is returned.

Specified by:

getFallbackTargetId in interface TargetIdManager

Throws:

IllegalStateException

getAvailableTargetIds

public List<String> getAvailableTargetIds()

Returns the available target IDs defined in the current site configuration. If not defined, and IllegalStateException is thrown.

Specified by:

getAvailableTargetIds in interface TargetIdManager