org.kuali.rice.kns.service
Interface TransactionalDocumentDictionaryService

All Known Implementing Classes:

TransactionalDocumentDictionaryServiceImpl

public interface TransactionalDocumentDictionaryService

This interface defines methods that a TransactionalDocumentDictionary Service must provide. Defines the API for the interacting with TransactionalDocument-related entries in the data dictionary.

Method Summary

Boolean	getAllowsCopy(TransactionalDocument document) Returns whether or not this document's data dictionary file has flagged it to allow document copies.
Class	getBusinessRulesClass(TransactionalDocument document)
Collection	getDefaultExistenceChecks(String docTypeName) The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
Collection	getDefaultExistenceChecks(TransactionalDocument document) The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
String	getDescription(String transactionalDocumentTypeName) Retrieves the full description of the transactional document as described in its data dictionary entry.
Class	getDocumentClassByName(String documentTypeName) Retrieves a document instance by it's class name.
String	getLabel(String transactionalDocumentTypeName) Retrieves the label for the transactional document as described in its data dictionary entry.

Method Detail

getAllowsCopy

Boolean getAllowsCopy(TransactionalDocument document)

Returns whether or not this document's data dictionary file has flagged it to allow document copies.

Parameters:

document -

Returns:

True if copies are allowed, false otherwise.

getDocumentClassByName

Class getDocumentClassByName(String documentTypeName)

Retrieves a document instance by it's class name.

Parameters:

documentTypeName -

Returns:

A document instance.

getDescription

String getDescription(String transactionalDocumentTypeName)

Retrieves the full description of the transactional document as described in its data dictionary entry.

Parameters:

transactionalDocumentTypeName -

Returns:

The transactional document's full description.

getLabel

String getLabel(String transactionalDocumentTypeName)

Retrieves the label for the transactional document as described in its data dictionary entry.

Parameters:

transactionalDocumentTypeName -

Returns:

The transactional document's label.

getBusinessRulesClass

Class getBusinessRulesClass(TransactionalDocument document)

Parameters:

document -

Returns:

businessRulesClass associated with the given document's type

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(TransactionalDocument document)

The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.

Parameters:

document -

Returns:

A Collection of ReferenceDefinitions

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(String docTypeName)

The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.

Parameters:

docTypeName -

Returns:

A Collection of ReferenceDefinitions