org.kuali.rice.kns.service.impl
Class TransactionalDocumentDictionaryServiceImpl

java.lang.Object
  org.kuali.rice.kns.service.impl.TransactionalDocumentDictionaryServiceImpl

All Implemented Interfaces:

TransactionalDocumentDictionaryService

public class TransactionalDocumentDictionaryServiceImpl
extends Object
implements TransactionalDocumentDictionaryService

This class is the service implementation for the TransactionalDocumentDictionary structure. Defines the API for the interacting with Document-related entries in the data dictionary. This is the default implementation that gets delivered with Kuali.

Field Summary

private DataDictionaryService

dataDictionaryService

Constructor Summary

TransactionalDocumentDictionaryServiceImpl()

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)
DataDictionary	getDataDictionary() Retrieves the data dictionary instance.
Collection	getDefaultExistenceChecks(String docTypeName) This overridden method ...
Collection	getDefaultExistenceChecks(TransactionalDocument document) This overridden method ...
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.
protected DocumentTypeDTO	getDocumentType(String documentTypeName) This method gets the workflow document type for the given documentTypeName
String	getLabel(String transactionalDocumentTypeName) Retrieves the label for the transactional document as described in its data dictionary entry.
private TransactionalDocumentEntry	getTransactionalDocumentEntry(TransactionalDocument document) Retrieves the document entry by transactional document class instance.
private TransactionalDocumentEntry	getTransactionalDocumentEntryBydocumentTypeName(String documentTypeName) Retrieves the document entry by transactional document type name.
void	setDataDictionaryService(DataDictionaryService dataDictionaryService) Sets the data dictionary instance.

Methods inherited from class java.lang.Object

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

Field Detail

dataDictionaryService

private DataDictionaryService dataDictionaryService

Constructor Detail

TransactionalDocumentDictionaryServiceImpl

public TransactionalDocumentDictionaryServiceImpl()

Method Detail

getAllowsCopy

public Boolean getAllowsCopy(TransactionalDocument document)

Description copied from interface: TransactionalDocumentDictionaryService

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

Specified by:

getAllowsCopy in interface TransactionalDocumentDictionaryService

Returns:

True if copies are allowed, false otherwise.

See Also:

org.kuali.rice.kns.service.TransactionalDocumentDictionaryService#getAllowsCopy(org.kuali.bo.TransactionalDocument)

getDocumentClassByName

public Class getDocumentClassByName(String documentTypeName)

Description copied from interface: TransactionalDocumentDictionaryService

Retrieves a document instance by it's class name.

Specified by:

getDocumentClassByName in interface TransactionalDocumentDictionaryService

Returns:

A document instance.

See Also:

TransactionalDocumentDictionaryService.getDocumentClassByName(java.lang.String)

getDescription

public String getDescription(String transactionalDocumentTypeName)

Description copied from interface: TransactionalDocumentDictionaryService

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

Specified by:

getDescription in interface TransactionalDocumentDictionaryService

Returns:

The transactional document's full description.

See Also:

org.kuali.rice.kns.service.TransactionalDocumentDictionaryService#getDescription(org.kuali.bo.TransactionalDocument)

getLabel

public String getLabel(String transactionalDocumentTypeName)

Description copied from interface: TransactionalDocumentDictionaryService

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

Specified by:

getLabel in interface TransactionalDocumentDictionaryService

Returns:

The transactional document's label.

See Also:

org.kuali.rice.kns.service.TransactionalDocumentDictionaryService#getDescription(org.kuali.bo.TransactionalDocument)

getBusinessRulesClass

public Class getBusinessRulesClass(TransactionalDocument document)

Specified by:

getBusinessRulesClass in interface TransactionalDocumentDictionaryService

Returns:

businessRulesClass associated with the given document's type

See Also:

org.kuali.rice.kns.service.TransactionalDocumentDictionaryService#getBusinessRulesClass(org.kuali.bo.TransactionalDocument)

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

Sets the data dictionary instance.

Parameters:

dataDictionaryService -

getDataDictionary

public DataDictionary getDataDictionary()

Retrieves the data dictionary instance.

Returns:

getDocumentType

protected DocumentTypeDTO getDocumentType(String documentTypeName)

This method gets the workflow document type for the given documentTypeName

Parameters:

documentTypeName -

Returns:

getTransactionalDocumentEntry

private TransactionalDocumentEntry getTransactionalDocumentEntry(TransactionalDocument document)

Retrieves the document entry by transactional document class instance.

Parameters:

document -

Returns:

TransactionalDocumentEntry

getTransactionalDocumentEntryBydocumentTypeName

private TransactionalDocumentEntry getTransactionalDocumentEntryBydocumentTypeName(String documentTypeName)

Retrieves the document entry by transactional document type name.

Parameters:

documentTypeName -

Returns:

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(String docTypeName)

This overridden method ...

Specified by:

getDefaultExistenceChecks in interface TransactionalDocumentDictionaryService

Returns:

A Collection of ReferenceDefinitions

See Also:

TransactionalDocumentDictionaryService.getDefaultExistenceChecks(java.lang.String)

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(TransactionalDocument document)

This overridden method ...

Specified by:

getDefaultExistenceChecks in interface TransactionalDocumentDictionaryService

Returns:

A Collection of ReferenceDefinitions

See Also:

TransactionalDocumentDictionaryService.getDefaultExistenceChecks(org.kuali.rice.kns.document.TransactionalDocument)