Campus.Builder (Rice Location API 2.5.16 API)

java.lang.Object
- org.kuali.rice.location.api.campus.Campus.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Coded, GloballyUnique, Versioned, ModelBuilder, CampusContract

Enclosing class:

Campus
```
public static class Campus.Builder
extends Object
implements CampusContract, ModelBuilder, Serializable
```
This builder is used to construct instances of Campus. It enforces the constraints of the CampusContract.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Campus`	`build()` Builds an instance of a Campus based on the current state of the builder.
`static Campus.Builder`	`create(CampusContract contract)` Creates a builder by populating it with data from the given `CampusContract`.
`static Campus.Builder`	`create(String code)` Creates a builder from the given campus code.
`CampusType.Builder`	`getCampusType()` This is the campus type for the Campus.
`String`	`getCode()`
`String`	`getName()` This is the name for the Campus.
`String`	`getObjectId()`
`String`	`getShortName()` This is the short name for the Campus.
`Long`	`getVersionNumber()`
`boolean`	`isActive()`
`void`	`setActive(boolean active)`
`void`	`setCampusType(CampusType.Builder campusType)`
`void`	`setCode(String code)` Sets the value of the code on this builder to the given value.
`void`	`setName(String name)`
`void`	`setObjectId(String objectId)`
`void`	`setShortName(String shortName)`
`void`	`setVersionNumber(Long versionNumber)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static Campus.Builder create(String code)
```
    Creates a builder from the given campus code.
    
    Parameters:
    
    code - the campus code
    
    Returns:
    
    an instance of the builder with the code already populated
    
    Throws:
    
    IllegalArgumentException - if the code is null or blank
  - create
```
public static Campus.Builder create(CampusContract contract)
```
    Creates a builder by populating it with data from the given CampusContract.
    
    Parameters:
    
    contract - the contract from which to populate this builder
    
    Returns:
    
    an instance of the builder populated with data from the contract
  - setCode
```
public void setCode(String code)
```
    Sets the value of the code on this builder to the given value.
    
    Parameters:
    
    code - the code value to set, must not be null or blank
    
    Throws:
    
    IllegalArgumentException - if the code is null or blank
  - setName
```
public void setName(String name)
```
  - setShortName
```
public void setShortName(String shortName)
```
  - setCampusType
```
public void setCampusType(CampusType.Builder campusType)
```
  - setActive
```
public void setActive(boolean active)
```
  - setVersionNumber
```
public void setVersionNumber(Long versionNumber)
```
  - setObjectId
```
public void setObjectId(String objectId)
```
  - getCode
```
public String getCode()
```
    Specified by:
    
    getCode in interface Coded
  - getName
```
public String getName()
```
    Description copied from interface: CampusContract
    
    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()
```
    Description copied from interface: CampusContract
    
    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.Builder getCampusType()
```
    Description copied from interface: CampusContract
    
    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()
```
    Specified by:
    
    isActive in interface Inactivatable
  - getVersionNumber
```
public Long getVersionNumber()
```
    Specified by:
    
    getVersionNumber in interface Versioned
  - getObjectId
```
public String getObjectId()
```
    Specified by:
    
    getObjectId in interface GloballyUnique
  - build
```
public Campus build()
```
    Builds an instance of a Campus based on the current state of the builder.
    
    Specified by:
    
    build in interface ModelBuilder
    
    Returns:
    
    the fully-constructed Campus

Class Campus.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

setCode

setName

setShortName

setCampusType

setActive

setVersionNumber

setObjectId

getCode

getName

getShortName

getCampusType

isActive

getVersionNumber

getObjectId

build