org.kuali.rice.coreservice.api.component

Interface ComponentContract

All Superinterfaces:

Coded, GloballyUnique, Inactivatable, Versioned

All Known Subinterfaces:

ComponentEbo

All Known Implementing Classes:

Component, Component.Builder

public interface ComponentContract
extends Versioned, GloballyUnique, Inactivatable, Coded

This is the contract for a Component. This represents functional/logical piece within a rice application or rice ecosystem.

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

getVersionNumber

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

getObjectId

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.Coded

getCode

Method Detail

getName

String getName()

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

Returns:

name

getNamespaceCode

String getNamespaceCode()

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.

Returns:

namespace code

getComponentSetId

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. Will return a null value if this component was not published as part of a component set.

Returns:

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