org.kuali.rice.coreservice.api.namespace
Class Namespace

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.coreservice.api.namespace.Namespace

All Implemented Interfaces:

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

public final class Namespace
extends AbstractDataTransferObject
implements NamespaceContract

An immutable representation of a NamespaceContract.

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

See Also:

NamespaceContract, Serialized Form

Nested Class Summary

static class	Namespace.Builder This builder is used to construct instances of Namespace.
static class	Namespace.Cache

Method Summary

String	getApplicationId() This the id of the application which owns this Namespace.
String	getCode() The code value for this object.
String	getName() This the name for the Namespace.
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

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.

getApplicationId

public String getApplicationId()

Description copied from interface: NamespaceContract

This the id of the application which owns this Namespace. If this namespace has no application owner, then this method will return null.

It is a way of assigning the Namespace to a specific rice application or rice ecosystem.

Specified by:

getApplicationId in interface NamespaceContract

Returns:

application id

getName

public String getName()

Description copied from interface: NamespaceContract

This the name for the Namespace. This can be null or a blank string.

Specified by:

getName in interface NamespaceContract

Returns:

name

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