| Method Summary |
|
| public Boolean | getAllowsCopy(MaintenanceDocument document)
Returns whether or not this document's data dictionary file has flagged it to allow document copies. |
| public Boolean | getAllowsNewOrCopy(String docTypeName)
Returns whether or not this document's data dictionary file has flagged it to allow maintenance new
or copy actions. |
| public Collection | getApplyApcRules(Class businessObjectClass)
|
| public Collection | getApplyApcRules(String docTypeName)
|
| public Class | getBusinessObjectClass(String docTypeName)
The instance of the business object class associated with this document type name. |
| public Class | getBusinessRulesClass(MaintenanceDocument document)
|
| public Class | getCollectionBusinessObjectClass(String docTypeName, String collectionName)
Returns the business object used to store the values for the given collection. |
| public String | getCollectionFieldDefaultValue(String docTypeName, String collectionName, String fieldName)
This method returns the defaultValue as it would appear in the UI on a maintenance document for a collection.
If both a defaultValue and a defaultValueFinderClass is present in the MaintainableFieldDefinition instance, then the
defaultValue will be preferentially returned. |
| public Collection | getDefaultExistenceChecks(Class businessObjectClass)
The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument. |
| public Collection | getDefaultExistenceChecks(String docTypeName)
The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument. |
| public String | getDocumentTypeName(Class businessObjectClass)
The document type name for a class instance. |
| public String | getFieldDefaultValue(Class boClass, String fieldName)
This method returns the defaultValue as it would appear in the UI on a maintenance document.
If both a defaultValue and a defaultValueFinderClass is present in the MaintainableFieldDefinition instance, then the
defaultValue will be preferentially returned. |
| public String | getFieldDefaultValue(String docTypeName, String fieldName)
This method returns the defaultValue as it would appear in the UI on a maintenance document.
If both a defaultValue and a defaultValueFinderClass is present in the MaintainableFieldDefinition instance, then the
defaultValue will be preferentially returned. |
| public List | getLockingKeys(String docTypeName)
|
| public Class | getMaintainableClass(String docTypeName)
Retrieves an instance of the class that represents the maintenance document. |
| public MaintainableCollectionDefinition | getMaintainableCollection(String docTypeName, String collectionName)
Returns the definition for the maintainable collection identified by "collectionName". |
| public List<MaintainableCollectionDefinition> | getMaintainableCollections(String docTypeName)
Gets a list of all top-level maintainable collections on the document. |
| public List<MaintainableCollectionDefinition> | getMaintainableCollections(MaintainableCollectionDefinition parentCollection)
|
| public MaintainableFieldDefinition | getMaintainableField(String docTypeName, String fieldName)
Returns the definition for the maintainable field identified by "fieldName". |
| public MaintainableItemDefinition | getMaintainableItem(String docTypeName, String itemName)
Returns the definition for the maintainable item identified by "itemName". |
| public List<MaintainableSectionDefinition> | getMaintainableSections(String docTypeName)
A List of maintainable section object instances corresponding to the document type name. |
| public String | getMaintenanceDescription(String docTypeName)
Retrieves the description of the maintenance document. |
| public MaintenanceDocumentEntry | getMaintenanceDocumentEntry(String docTypeName)
|
| public String | getMaintenanceLabel(String docTypeName)
Retrieves the label for a maintenance document. |
| public void | validateMaintainableCollectionsAddLineRequiredFields(MaintenanceDocument document, PersistableBusinessObject businessObject, String collectionName)
|
| public void | validateMaintainableCollectionsForDuplicateEntries(MaintenanceDocument document)
|
| public void | validateMaintenanceRequiredFields(MaintenanceDocument document)
Validates the maintenance document contains values for the fields declared as required in the
maintenance document data dictionary file. |