Package org.kuali.rice.kim.api.type

Class KimType

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kim.api.type.KimType

All Implemented Interfaces:

Serializable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, KimTypeContract

public final class KimType
extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
implements KimTypeContract

An immutable representation of a KimTypeContract.

To construct an instance of a KimType, use the KimType.Builder class.

See Also:

• KimTypeContract
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KimType.Builder	This builder constructs an KimType enforcing the constraints of the KimTypeContract.
static class	KimType.Cache

Method Summary

Modifier and Type	Method	Description
KimTypeAttribute	getAttributeDefinitionById(String id)	Gets the KimTypeAttribute matching the id of it's KimAttribute.
KimTypeAttribute	getAttributeDefinitionByName(String name)	Gets the KimTypeAttribute matching the name of it's KimAttribute.
List<KimTypeAttribute>	getAttributeDefinitions()	The list of attribute definitions associated with the kim type.
String	getId()
String	getName()	The name of the kim type.
String	getNamespaceCode()	The namespace code that this kim type belongs too.
String	getObjectId()
String	getServiceName()	The service name used to resolve attribute values.
Long	getVersionNumber()
boolean	isActive()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getAttributeDefinitionById

public KimTypeAttribute getAttributeDefinitionById(String id)

Gets the KimTypeAttribute matching the id of it's KimAttribute. If no attribute definition exists with that id then null is returned.

If multiple exist with the same id then the first match is returned. Since id is supposed to be unique this should not be a problem in practice.

Parameters:

id - the KimTypeAttribute.KimAttribute's id

Returns:

the KimTypeAttribute or null

Throws:

IllegalArgumentException - if the id is blank

getAttributeDefinitionByName

public KimTypeAttribute getAttributeDefinitionByName(String name)

Gets the KimTypeAttribute matching the name of it's KimAttribute. If no attribute definition exists with that name then null is returned.

If multiple exist with the same name then the first match is returned. Since name is supposed to be unique this should not be a problem in practice.

Parameters:

name - the KimTypeAttribute's name

Returns:

the KimTypeAttribute or null

Throws:

IllegalArgumentException - if the name is blank

getId

public String getId()

Specified by:

getId in interface org.kuali.rice.core.api.mo.common.Identifiable

getServiceName

public String getServiceName()

Description copied from interface: KimTypeContract

The service name used to resolve attribute values.

Specified by:

getServiceName in interface KimTypeContract

Returns:

the service name

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: KimTypeContract

The namespace code that this kim type belongs too.

Specified by:

getNamespaceCode in interface KimTypeContract

Returns:

namespace code

getName

public String getName()

Description copied from interface: KimTypeContract

The name of the kim type.

Specified by:

getName in interface KimTypeContract

Returns:

the name

getAttributeDefinitions

public List<KimTypeAttribute> getAttributeDefinitions()

Description copied from interface: KimTypeContract

The list of attribute definitions associated with the kim type. This cannot be null. If no attribute definitions are associated with the kim type then this will return an empty collection.

Specified by:

getAttributeDefinitions in interface KimTypeContract

Returns:

the list of attribute definitions

isActive

public boolean isActive()

Specified by:

isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique