Package org.kuali.rice.kns.service

Interface TransactionalDocumentDictionaryService

@Deprecated public interface TransactionalDocumentDictionaryService
Deprecated.
Only used in KNS classes, use KRAD.
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

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

  • Method Details

    • getAllowsCopy

      Boolean getAllowsCopy(TransactionalDocument document)
      Deprecated.
      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)
      Deprecated.
      Retrieves a document instance by it's class name.
      Parameters:
      documentTypeName -
      Returns:
      A document instance.

    • getDescription

      String getDescription(String transactionalDocumentTypeName)
      Deprecated.
      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)
      Deprecated.
      Retrieves the label for the transactional document as described in its data dictionary entry.
      Parameters:
      transactionalDocumentTypeName -
      Returns:
      The transactional document's label.

    • getDefaultExistenceChecks

      Collection getDefaultExistenceChecks(TransactionalDocument document)
      Deprecated.
      The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
      Parameters:
      document -
      Returns:
      A Collection of ReferenceDefinitions

    • getDefaultExistenceChecks

      Collection getDefaultExistenceChecks(String docTypeName)
      Deprecated.
      The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument.
      Parameters:
      docTypeName -
      Returns:
      A Collection of ReferenceDefinitions