Package org.kuali.rice.krad.service

Interface DataObjectMetaDataService

All Known Subinterfaces:
BusinessObjectMetaDataService
All Known Implementing Classes:
DataObjectMetaDataServiceImpl
@Deprecated public interface DataObjectMetaDataService
Deprecated.
use MetadataRepository instead
Provides metadata such as relationships and key fields for data objects

Service provides a facade to the various services for retrieving metadata within the framework, such as the DataDictionaryService and the PersistenceService

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • listPrimaryKeyFieldNames

      @Deprecated List<String> listPrimaryKeyFieldNames(Class<?> clazz)
      Deprecated.
      use DataObjectMetadata.getPrimaryKeyAttributeNames()
      Checks the DataDictionary and OJB Repository File to determine the primary fields names for a given class.
      Parameters:
      clazz - - the Class to check for primary keys
      Returns:
      a list of the primary key field names or an empty list if none are found

    • getPrimaryKeyFieldValues

      @Deprecated Map<String,?> getPrimaryKeyFieldValues(Object dataObject)
      Deprecated.
      use DataObjectWrapper.getPrimaryKeyValues() instead
      Determines the primary keys for the class of the given object, then for each key field retrieves the value from the object instance and populates the return map with the primary key name as the map key and the object value as the map value
      Parameters:
      dataObject - - object whose primary key field name,value pairs you want
      Returns:
      a Map containing the names and values of fields for the given class which are designated as key fields in the OJB repository file or DataDictionary
      Throws:
      IllegalArgumentException - if the given Object is null

    • getPrimaryKeyFieldValues

      @Deprecated Map<String,?> getPrimaryKeyFieldValues(Object dataObject, boolean sortFieldNames)
      Deprecated.
      use DataObjectWrapper.getPrimaryKeyValues() instead, and sort manually if needed
      Determines the primary keys for the class of the given object, then for each key field retrieves the value from the object instance and populates the return map with the primary key name as the map key and the object value as the map value
      Parameters:
      dataObject - - object whose primary key field name,value pairs you want
      sortFieldNames - - if true, the returned Map will iterate through its entries sorted by fieldName
      Returns:
      a Map containing the names and values of fields for the given class which are designated as key fields in the OJB repository file or DataDictionary
      Throws:
      IllegalArgumentException - if the given Object is null

    • equalsByPrimaryKeys

      @Deprecated boolean equalsByPrimaryKeys(Object do1, Object do2)
      Deprecated.
      use DataObjectWrapper.equalsByPrimaryKey(Object)
      Compares two dataObject instances for equality of type and key values using toString() of each value for comparison purposes.
      Parameters:
      do1 -
      do2 -
      Returns:
      boolean indicating whether the two objects are equal.

    • getDataObjectRelationship

      @Deprecated DataObjectRelationship getDataObjectRelationship(Object dataObject, Class<?> dataObjectClass, String attributeName, String attributePrefix, boolean keysOnly, boolean supportsLookup, boolean supportsInquiry)
      Deprecated.
      Attempts to find a relationship for the given attribute within the given data object

      First the data dictionary is queried to find any relationship definitions setup that include the attribute, if found the BusinessObjectRetationship is build from that. If not and the data object class is persistent, relationships are retrieved from the persistence service. Nested attributes are handled in addition to external business objects. If multiple relationships are found, the one that contains the least amount of joining keys is returned

      Parameters:
      dataObject - - data object instance that contains the attribute
      dataObjectClass - - class for the data object that contains the attribute
      attributeName - - property name for the attribute
      attributePrefix - - property prefix for the attribute
      keysOnly - - indicates whether only primary key fields should be returned in the relationship
      supportsLookup - - indicates whether the relationship should support lookup
      supportsInquiry - - indicates whether the relationship should support inquiry
      Returns:
      BusinessObjectRelationship for the attribute, or null if not found

    • getDataObjectRelationships

      @Deprecated List<DataObjectRelationship> getDataObjectRelationships(Class<?> dataObjectClass)
      Deprecated.
      Attempts to find relationships for the given data object class

      First the data dictionary is queried to find any relationship definitions BusinessObjectRetationship is build from that. If not and the data object class is persistent, relationships are retrieved from the persistence service. Nested attributes are handled in addition to external business objects. If multiple relationships are found, the one that contains the least amount of joining keys is returned

      Parameters:
      dataObjectClass - - class for the data object that contains the attribute
      Returns:
      List of DataObjectRelationship for the class

    • getDictionaryRelationship

      @Deprecated RelationshipDefinition getDictionaryRelationship(Class<?> dataObjectClass, String attributeName)
      Deprecated.
      Fetches the RelationshipDefinition for the attribute with the given name within the given class
      Parameters:
      dataObjectClass - - data object class that contains the attribute
      attributeName - - property name for the attribute
      Returns:
      RelationshipDefinition for the attribute, or null if not found

    • getTitleAttribute

      @Deprecated String getTitleAttribute(Class<?> dataObjectClass)
      Deprecated.
      Returns the attribute to be associated with for object level markings. This would be the field chosen for inquiry links etc.
      Parameters:
      dataObjectClass - - data object class to obtain title attribute of
      Returns:
      property name of title attribute or null if data object entry not found
      Throws:
      IllegalArgumentException - if the given Class is null

    • areNotesSupported

      @Deprecated boolean areNotesSupported(Class<?> dataObjectClass)
      Deprecated.
      Indicates whether notes are supported by the given data object class, currently this can only be true for business objects
      Parameters:
      dataObjectClass - - class for data object to check
      Returns:
      boolean true if notes are supported for data object, false if notes are not supported

    • getDataObjectIdentifierString

      @Deprecated String getDataObjectIdentifierString(Object dataObject)
      Deprecated.
      Builds a string that uniquely identifiers the data object instance

      Based on the metadata available for the class of the data object, the values for fields that uniquely identify an instance are concatenated together into one string. For general data objects these fields will be the primary key fields defined in the data dictionary. For the case of objects with type PersistableBusinessObject, the object id field will be used.

      Parameters:
      dataObject - - data object instance to build identifier string for
      Returns:
      String identifier string for data object

    • hasLocalLookup

      @Deprecated boolean hasLocalLookup(Class<?> dataObjectClass)
      Deprecated.
      Determines whether the given data object class has an associated lookup in the local running application
      Parameters:
      dataObjectClass - data object class to find lookup for
      Returns:
      boolean true if a lookup exists for the data object class, false if not

    • hasLocalInquiry

      @Deprecated boolean hasLocalInquiry(Class<?> dataObjectClass)
      Deprecated.
      Determines whether the given data object class has an associated inquiry in the local running application
      Parameters:
      dataObjectClass - data object class to find inquiry for
      Returns:
      boolean true if a inquiry exists for the data object class, false if not