org.kuali.rice.location.impl.country

Class CountryBo

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.location.impl.country.CountryBo

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Inactivatable, MutableInactivatable, Coded, GloballyUnique, Versioned, ModelObjectBasic, BusinessObject, ExternalizableBusinessObject, PersistableBusinessObject, CountryContract, CountryEbo

@Entity
public class CountryBo
extends PersistableBusinessObjectBase
implements CountryEbo

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, newCollectionRecord, objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
CountryBo()

Method Summary

Methods

Modifier and Type	Method and Description
static CountryBo	from(Country immutable) Creates a CountryBo business object from an immutable representation of a Country.
String	getAlternateCode() An alternative country code to represent a country.
String	getCode() The code value for this object.
String	getName() A full, familiar, name of a country.
boolean	isActive() The active indicator for an object.
boolean	isRestricted() Value representing whether a country is restricted.
void	setActive(boolean active) Sets the record to active or inactive.
void	setAlternateCode(String alternateCode)
void	setCode(String code)
void	setName(String name)
void	setRestricted(boolean restricted)
static Country	to(CountryBo bo) Converts a mutable CountryBo to an immutable Country representation.

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, getObjectId, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.location.framework.country.CountryEbo

getVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

CountryBo

public CountryBo()

Method Detail

getCode

public String getCode()

Description copied from interface: CountryEbo

The code value for this object. In general a code value cannot be null or a blank string. An abbreviated String representing the unique identifying code for a given country. This code correlates directly to the alpha-2 country codes from the ISO-3166-1-alpha-2 standard.

This property is required to exist.

An abbreviated String representing the unique identifying code for a given country. This code correlates directly to the alpha-2 country codes from the ISO-3166-1-alpha-2 standard.

This property is required to exist.

Specified by:

getCode in interface Coded

Specified by:

getCode in interface CountryContract

Specified by:

getCode in interface CountryEbo

Returns:

the code value for this object.

setCode

public void setCode(String code)

getAlternateCode

public String getAlternateCode()

Description copied from interface: CountryEbo

An alternative country code to represent a country. This code correlats directly to the alpha-3 codes from the ISO_3166-1-alpha-3 standard.

This property is optional

Specified by:

getAlternateCode in interface CountryContract

Specified by:

getAlternateCode in interface CountryEbo

Returns:

The alternate country code if it exists. null is returned if an alternate code does not exist.

setAlternateCode

public void setAlternateCode(String alternateCode)

getName

public String getName()

Description copied from interface: CountryEbo

A full, familiar, name of a country.

This property is optional

Specified by:

getName in interface CountryContract

Specified by:

getName in interface CountryEbo

Returns:

The name of a country if it exists. null is returned if a full name does not exist.

setName

public void setName(String name)

isRestricted

public boolean isRestricted()

Description copied from interface: CountryEbo

Value representing whether a country is restricted.

The meaning of restricted for a country varies depending upon the implementer - for instance if a country may not be used in the address of a Vendor.

The default value of this property is false.

Specified by:

isRestricted in interface CountryContract

Specified by:

isRestricted in interface CountryEbo

Returns:

if a country is restricted.

setRestricted

public void setRestricted(boolean restricted)

isActive

public boolean isActive()

Description copied from interface: CountryEbo

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Specified by:

isActive in interface CountryEbo

Returns:

true if active false if not.

setActive

public void setActive(boolean active)

Description copied from interface: CountryEbo

Sets the record to active or inactive.

Specified by:

setActive in interface MutableInactivatable

Specified by:

setActive in interface CountryEbo

to

public static Country to(CountryBo bo)

Converts a mutable CountryBo to an immutable Country representation.

Parameters:

bo -

Returns:

an immutable Country

from

public static CountryBo from(Country immutable)

Creates a CountryBo business object from an immutable representation of a Country.

Parameters:

immutable - an immutable Country

Returns:

a CountryBo