org.kuali.rice.location.api.campus
Class Campus

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.location.api.campus.Campus

All Implemented Interfaces:

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

public final class Campus
extends AbstractDataTransferObject
implements CampusContract

An immutable representation of a CampusContract.

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

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

CampusContract, Serialized Form

Nested Class Summary

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

Method Summary

CampusType	getCampusType() This is the campus type for the Campus.
String	getCode() The code value for this object.
String	getName() This is the name for the Campus.
String	getObjectId() Return the globally unique object id of this object.
String	getShortName() This is the short name for the Campus.
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()

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

This is the name for the Campus.

It is a name a campus.

Specified by:

getName in interface CampusContract

Returns:

name for Campus.

getShortName

public String getShortName()

This is the short name for the Campus.

It is a shorter name for a campus.

Specified by:

getShortName in interface CampusContract

Returns:

short name for Campus.

getCampusType

public CampusType getCampusType()

This is the campus type for the Campus.

It is a object that defines the type of a campus.

Specified by:

getCampusType in interface CampusContract

Returns:

short name for Campus.

isActive

public boolean isActive()

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

public 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

public 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