org.kuali.rice.coreservice.api.component

Class Component

java.lang.Object

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

org.kuali.rice.coreservice.api.component.Component

All Implemented Interfaces:

Serializable, Inactivatable, Coded, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, ComponentContract

public final class Component
extends AbstractDataTransferObject
implements ComponentContract

An immutable representation of an ComponentContract. Use the class Component.Builder to construct an Component object.

See Also:

ComponentContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Component.Builder This builder is used to construct instances of Component.
static class	Component.Cache

Method Summary

Modifier and Type	Method and Description
String	getCode() The code value for this object.
String	getComponentSetId() Returns the id of the component set this component belongs to if this component was published as part of such a component set.
String	getName() This is the name value for the component.
String	getNamespaceCode() This is the namespace for the component.
String	getObjectId() Return the globally unique object id of this object.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.

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

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: ComponentContract

This is the namespace for the component. It cannot be null or a blank string.

It is a way of assigning the component to a logical grouping within a rice application or rice ecosystem.

Specified by:

getNamespaceCode in interface ComponentContract

Returns:

namespace code

getCode

public String getCode()

Description copied from interface: Coded

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

getName

public String getName()

Description copied from interface: ComponentContract

This is the name value for the component. It cannot be null or a blank string.

Specified by:

getName in interface ComponentContract

Returns:

name

getComponentSetId

public String getComponentSetId()

Description copied from interface: ComponentContract

Returns the id of the component set this component belongs to if this component was published as part of such a component set. Will return a null value if this component was not published as part of a component set.

Specified by:

getComponentSetId in interface ComponentContract

Returns:

the id of the component set this component was published under, or null if this component is not part of a published set

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet