org.kuali.coeus.s2sgen.api.generate

Interface FormMappingService

All Known Implementing Classes:

FormMappingServiceImpl

public interface FormMappingService

This service retrieves information about the currently configured form generation.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,FormMappingInfo>	getBindings() Gets form generation info for all namespaces, keyed by namespace.
FormMappingInfo	getFormInfo(String namespace) Gets form generation info for a specific namespace.
FormMappingInfo	getFormInfo(String namespace, String proposalNumber) Gets form generation info for a specific namespace and proposal number.
Map<Integer,Set<String>>	getSortedNameSpaces() Gets form generation info for all namespaces, keyed by namespace.
void	registerForm(FormMappingInfo info)

Method Detail

getFormInfo

FormMappingInfo getFormInfo(String namespace)

Gets form generation info for a specific namespace. the namespace cannot be blank.

Parameters:

namespace - the namespace. cannot be blank.

Returns:

the form generation info or null if it cannot be found

Throws:

IllegalArgumentException - if the namespace is blank

getFormInfo

FormMappingInfo getFormInfo(String namespace,
                          String proposalNumber)

Gets form generation info for a specific namespace and proposal number. the namespace and proposal number cannot be blank.

Parameters:

namespace - the namespace. cannot be blank.

proposalNumber - the proposal number for an existing proposal. cannot be blank.

Returns:

the form generation info or null if it cannot be found

Throws:

IllegalArgumentException - if the namespace or proposalNumber is blank

getBindings

Map<String,FormMappingInfo> getBindings()

Gets form generation info for all namespaces, keyed by namespace.

Returns:

returns a map. always non-null

getSortedNameSpaces

Map<Integer,Set<String>> getSortedNameSpaces()

Gets form generation info for all namespaces, keyed by namespace.

Returns:

returns a map. always non-null

registerForm

void registerForm(FormMappingInfo info)