org.kuali.rice.coreservice.framework.component
Interface ComponentEbo

All Superinterfaces:
BusinessObject, Coded, ComponentContract, ExternalizableBusinessObject, GloballyUnique, Inactivatable, ModelObjectBasic, MutableInactivatable, Serializable, Versioned

public interface ComponentEbo
extends ComponentContract, ExternalizableBusinessObject, MutableInactivatable

TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed


Method Summary
 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.
 void setActive(boolean active)
          Sets the record to active or inactive.
 
Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject
refresh
 
Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic
toString
 

Method Detail

getName

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

Specified by:
getName in interface ComponentContract
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.

Specified by:
getNamespaceCode in interface ComponentContract
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.

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

getVersionNumber

Long getVersionNumber()
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

String getObjectId()
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

isActive

boolean isActive()
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Returns:
true if active false if not.

setActive

void setActive(boolean active)
Sets the record to active or inactive.

Specified by:
setActive in interface MutableInactivatable

getCode

String getCode()
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.


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.