org.kuali.rice.krms.api.repository.reference

Class ReferenceObjectBinding.Builder

java.lang.Object

org.kuali.rice.krms.api.repository.reference.ReferenceObjectBinding.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelBuilder, ReferenceObjectBindingContract

Enclosing class:

ReferenceObjectBinding

public static final class ReferenceObjectBinding.Builder
extends Object
implements Serializable, ModelBuilder, ReferenceObjectBindingContract

A builder which can be used to construct ReferenceObjectBinding instances. Enforces the constraints of the ReferenceObjectBindingContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ReferenceObjectBinding	build() Builds an instance of a ReferenceObjectBinding based on the current state of the builder.
static ReferenceObjectBinding.Builder	create(ReferenceObjectBindingContract contract)
static ReferenceObjectBinding.Builder	create(String krmsDiscriminatorType, String krmsObjectId, String namespace, String referenceDiscriminatorType, String referenceObjectId)
String	getCollectionName() This is the CollectionName of the ReferenceObjectBinding
String	getId() The unique identifier for an object.
String	getKrmsDiscriminatorType() This is the KrmsDiscriminatorType of the ReferenceObjectBinding
String	getKrmsObjectId() This is the KrmsObjectId of the ReferenceObjectBinding
String	getNamespace() This is the namespace of the ReferenceObjectBinding
String	getReferenceDiscriminatorType() This is the ReferenceDiscriminatorType of the ReferenceObjectBinding
String	getReferenceObjectId() This is the ReferenceObjectId of the ReferenceObjectBinding
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active) Sets the value of active on this builder to the given value.
void	setCollectionName(String collectionName) Sets the value of collectionName on this builder to the given value.
void	setId(String id) Sets the value of id on this builder to the given value.
void	setKrmsDiscriminatorType(String krmsDiscriminatorType) Sets the value of krmsDiscriminatorType on this builder to the given value.
void	setKrmsObjectId(String krmsObjectId) Sets the value of krmsObjectId on this builder to the given value.
void	setNamespace(String namespace) Sets the value of namespace on this builder to the given value.
void	setReferenceDiscriminatorType(String referenceDiscriminatorType) Sets the value of referenceDiscriminatorType on this builder to the given value.
void	setReferenceObjectId(String referenceObjectId) Sets the value of referenceObjectId on this builder to the given value.
void	setVersionNumber(Long versionNumber) Sets the value of versionNumber on this builder to the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ReferenceObjectBinding.Builder create(String krmsDiscriminatorType,
                                    String krmsObjectId,
                                    String namespace,
                                    String referenceDiscriminatorType,
                                    String referenceObjectId)

create

public static ReferenceObjectBinding.Builder create(ReferenceObjectBindingContract contract)

build

public ReferenceObjectBinding build()

Builds an instance of a ReferenceObjectBinding based on the current state of the builder.

Specified by:

build in interface ModelBuilder

Returns:

the fully-constructed ReferenceObjectBinding.

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.

getCollectionName

public String getCollectionName()

Description copied from interface: ReferenceObjectBindingContract

This is the CollectionName of the ReferenceObjectBinding

The CollectionName of the ReferenceObjectBinding

Specified by:

getCollectionName in interface ReferenceObjectBindingContract

Returns:

the CollectionName of the ReferenceObjectBinding

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getKrmsDiscriminatorType

public String getKrmsDiscriminatorType()

Description copied from interface: ReferenceObjectBindingContract

This is the KrmsDiscriminatorType of the ReferenceObjectBinding

The KrmsDiscriminatorType of the ReferenceObjectBinding

Specified by:

getKrmsDiscriminatorType in interface ReferenceObjectBindingContract

Returns:

the KrmsDiscriminatorType of the ReferenceObjectBinding

getKrmsObjectId

public String getKrmsObjectId()

Description copied from interface: ReferenceObjectBindingContract

This is the KrmsObjectId of the ReferenceObjectBinding

The KrmsObjectId of the ReferenceObjectBinding

Specified by:

getKrmsObjectId in interface ReferenceObjectBindingContract

Returns:

the KrmsObjectId of the ReferenceObjectBinding

getNamespace

public String getNamespace()

Description copied from interface: ReferenceObjectBindingContract

This is the namespace of the ReferenceObjectBinding

The namespace of the ReferenceObjectBinding

Specified by:

getNamespace in interface ReferenceObjectBindingContract

Returns:

the namespace of the ReferenceObjectBinding

getReferenceDiscriminatorType

public String getReferenceDiscriminatorType()

Description copied from interface: ReferenceObjectBindingContract

This is the ReferenceDiscriminatorType of the ReferenceObjectBinding

The ReferenceDiscriminatorType of the ReferenceObjectBinding

Specified by:

getReferenceDiscriminatorType in interface ReferenceObjectBindingContract

Returns:

the ReferenceDiscriminatorType of the ReferenceObjectBinding

getReferenceObjectId

public String getReferenceObjectId()

Description copied from interface: ReferenceObjectBindingContract

This is the ReferenceObjectId of the ReferenceObjectBinding

The ReferenceObjectId of the ReferenceObjectBinding

Specified by:

getReferenceObjectId in interface ReferenceObjectBindingContract

Returns:

the ReferenceObjectId of the ReferenceObjectBinding

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

setActive

public void setActive(boolean active)

Sets the value of active on this builder to the given value.

Parameters:

active - the active value to set.

setCollectionName

public void setCollectionName(String collectionName)

Sets the value of collectionName on this builder to the given value.

Parameters:

collectionName - the collectionName value to set.

setId

public void setId(String id)

Sets the value of id on this builder to the given value.

Parameters:

id - the id value to set., may be null, representing the Object has not been persisted, but must not be blank.

Throws:

IllegalArgumentException - if the id is blank

setKrmsDiscriminatorType

public void setKrmsDiscriminatorType(String krmsDiscriminatorType)

Sets the value of krmsDiscriminatorType on this builder to the given value.

Parameters:

krmsDiscriminatorType - the krmsDiscriminatorType value to set., must not be null or blank

Throws:

IllegalArgumentException - if the krmsDiscriminatorType is null or blank

setKrmsObjectId

public void setKrmsObjectId(String krmsObjectId)

Sets the value of krmsObjectId on this builder to the given value.

Parameters:

krmsObjectId - the krmsObjectId value to set., must not be null or blank

Throws:

IllegalArgumentException - if the krmsObjectId is null or blank

setNamespace

public void setNamespace(String namespace)

Sets the value of namespace on this builder to the given value.

Parameters:

namespace - the namespace value to set., must not be null or blank

Throws:

IllegalArgumentException - if the namespace is null or blank

setReferenceDiscriminatorType

public void setReferenceDiscriminatorType(String referenceDiscriminatorType)

Sets the value of referenceDiscriminatorType on this builder to the given value.

Parameters:

referenceDiscriminatorType - the referenceDiscriminatorType value to set., must not be null or blank

Throws:

IllegalArgumentException - if the referenceDiscriminatorType is null or blank

setReferenceObjectId

public void setReferenceObjectId(String referenceObjectId)

Sets the value of referenceObjectId on this builder to the given value.

Parameters:

referenceObjectId - the referenceObjectId value to set., must not be null or blank

Throws:

IllegalArgumentException - if the referenceObjectId is null or blank

setVersionNumber

public void setVersionNumber(Long versionNumber)

Sets the value of versionNumber on this builder to the given value.

Parameters:

versionNumber - the versionNumber value to set.