This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.usecase
Interface UsecaseResolver

All Known Implementing Classes:

UsecaseResolverImpl

public interface UsecaseResolver

Usecase resolver interface.

Version:

$Id: UsecaseResolver.java 488305 2006-12-18 15:43:43Z andreas $

Field Summary

static java.lang.String

ROLE The Avalon role.

Method Summary

java.lang.String[]	getUsecaseNames()
boolean	isRegistered(java.lang.String webappUrl, java.lang.String name) Checks if a certain usecase is registered.
void	register(java.lang.String usecaseName)
void	release(Usecase usecase) Releases a usecase object.
Usecase	resolve(java.lang.String webappUrl, java.lang.String name) Resolves a usecase object.

Field Detail

ROLE

static final java.lang.String ROLE

The Avalon role.

Method Detail

resolve

Usecase resolve(java.lang.String webappUrl,
                java.lang.String name)
                throws org.apache.avalon.framework.service.ServiceException

Resolves a usecase object.

Parameters:

webappUrl - The web application URL.

name - The name of the usecase.

Returns:

A usecase object.

Throws:

org.apache.avalon.framework.service.ServiceException - if the object could not be created.

isRegistered

boolean isRegistered(java.lang.String webappUrl,
                     java.lang.String name)
                     throws org.apache.avalon.framework.service.ServiceException

Checks if a certain usecase is registered.

Parameters:

webappUrl - The web application URL.

name - The usecase name.

Returns:

A boolean value.

Throws:

org.apache.avalon.framework.service.ServiceException - if an error occurs.

release

void release(Usecase usecase)
             throws org.apache.avalon.framework.service.ServiceException

Releases a usecase object.

Parameters:

usecase - The usecase object.

Throws:

org.apache.avalon.framework.service.ServiceException - if an error occurs.

getUsecaseNames

java.lang.String[] getUsecaseNames()

Returns:

The names of all registered usecases in alphabetical order.

register

void register(java.lang.String usecaseName)

Parameters:

usecaseName - The usecase to register.