org.kuali.rice.kew.api.repository.type

Class KewTypeDefinition

java.lang.Object

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

org.kuali.rice.kew.api.repository.type.KewTypeDefinition

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, KewTypeDefinitionContract

public final class KewTypeDefinition
extends AbstractDataTransferObject
implements KewTypeDefinitionContract

Concrete model object implementation of KEW KewType. immutable. Instances of KewType can be (un)marshalled to and from XML.

See Also:

KewTypeDefinitionContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KewTypeDefinition.Builder This builder is used to construct instances of KEW KewType.
static class	KewTypeDefinition.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Method Summary

Modifier and Type	Method and Description
KewAttributeDefinition	getAttributeDefinitionByName(String name) Gets the KewTypeAttribute matching the name of it's KewAttribute.
List<KewTypeAttribute>	getAttributes() This method returns a list of attributes associated with the KewType
String	getId()
String	getName() This is the name for the KEWType
String	getNamespace() This is the namespace code.
String	getServiceName() This is the name of the KEW KewType service
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 Detail

getId

public String getId()

Specified by:

getId in interface Identifiable

getName

public String getName()

Description copied from interface: KewTypeDefinitionContract

This is the name for the KEWType

It is a name of a KEW type.

Specified by:

getName in interface KewTypeDefinitionContract

Returns:

name for KEW type.

getNamespace

public String getNamespace()

Description copied from interface: KewTypeDefinitionContract

This is the namespace code.

It provides scope of the KEW type.

Specified by:

getNamespace in interface KewTypeDefinitionContract

Returns:

the namespace code of the KEW type.

getServiceName

public String getServiceName()

Description copied from interface: KewTypeDefinitionContract

This is the name of the KEW KewType service

Specified by:

getServiceName in interface KewTypeDefinitionContract

Returns:

the service name of the KEW type

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable

getAttributes

public List<KewTypeAttribute> getAttributes()

Description copied from interface: KewTypeDefinitionContract

This method returns a list of attributes associated with the KewType

Specified by:

getAttributes in interface KewTypeDefinitionContract

Returns:

a list of KewTypeAttribute objects.

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

getAttributeDefinitionByName

public KewAttributeDefinition getAttributeDefinitionByName(String name)

Gets the KewTypeAttribute matching the name of it's KewAttribute. 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 KewTypeAttribute's name

Returns:

the KewTypeAttribute or null

Throws:

IllegalArgumentException - if the name is blank