Package org.kuali.rice.krms.api.repository.type

Interface KrmsTypeDefinitionContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
KrmsTypeDefinition, KrmsTypeDefinition.Builder
public interface KrmsTypeDefinitionContract extends org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
Defines the contract for a KRMS type definition.

A KrmsTypeDefinition is a metadata wrapper around a KRMS type service. This contains a collection of related attributes. This also provides the name of the service used to resolve these attributes.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<? extends KrmsTypeAttributeContract>
    getAttributes()
    Returns a list of attributes associated with the KRMS type definition.
    String
    getName()
    Returns the name of the KrmsTypeDefinition.
    String
    getNamespace()
    Returns the namespace to which the KrmsTypeDefinition belongs.
    String
    getServiceName()
    Returns the name of the service used to resolve attribute values.

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

    getId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Method Details

    • getName

      String getName()
      Returns the name of the KrmsTypeDefinition. All KrmsTypeDefinitions have a name, so this value can not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.
      Returns:
      the name of this KrmsTypeDefinition

    • getNamespace

      String getNamespace()
      Returns the namespace to which the KrmsTypeDefinition belongs. All type definitions exist within a namespace. This value can not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.
      Returns:
      the namespace of this KrmsTypeDefinition

    • getServiceName

      String getServiceName()
      Returns the name of the service used to resolve attribute values. The service name may be null or blank.
      Returns:
      the service name of this KrmsTypeDefinition

    • getAttributes

      List<? extends KrmsTypeAttributeContract> getAttributes()
      Returns a list of attributes associated with the KRMS type definition. This can be empty, but will never be null. If no attribute definitions are associated with the KRMS type then this will return an empty collection.
      Returns:
      the list of KrmsTypeAttributeContract attribute definition contracts