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

java.lang.Object
  org.kuali.rice.core.api.namespace.Namespace

All Implemented Interfaces:

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

public final class Namespace
extends Object
implements NamespaceContract, ModelObjectComplete

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.
(package private) static class	Namespace.Constants Defines some internal constants used on this class.
(package private) static class	Namespace.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Field Summary

private Collection<Element>	_futureElements
private boolean	active
private String	applicationId
private String	code
private String	name
private String	objectId
private static long	serialVersionUID
private Long	versionNumber

Constructor Summary

private	Namespace() This constructor should never be called.
private	Namespace(Namespace.Builder builder) Constructs a Namespace from the given builder.

Method Summary

boolean	equals(Object obj) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
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.
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
boolean	isActive() The active indicator for an object.
String	toString() This will return a proper string representation of the Model Object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

code

private final String code

applicationId

private final String applicationId

name

private final String name

active

private final boolean active

versionNumber

private final Long versionNumber

objectId

private final String objectId

_futureElements

private final Collection<Element> _futureElements

Constructor Detail

Namespace

private Namespace()

This constructor should never be called. It is only present for use during JAXB unmarshalling.

Namespace

private Namespace(Namespace.Builder builder)

Constructs a Namespace from the given builder. This constructor is private and should only ever be invoked from the builder.

Parameters:

builder - the Builder from which to construct the namespace

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. This cannot be null or a blank string.

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: ImmutableInactivatable

The active indicator for an object.

Specified by:

isActive in interface ImmutableInactivatable

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

hashCode

public int hashCode()

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

Returns:

the hashCode value

equals

public boolean equals(Object obj)

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

Parameters:

obj - to object to compare for equality

Returns:

if equal

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation