org.kuali.rice.krms.impl.repository

Class ContextBo

java.lang.Object

org.kuali.rice.krms.impl.repository.ContextBo

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ContextDefinitionContract

@Entity
public class ContextBo
extends Object
implements ContextDefinitionContract, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_SEQ_NAME

Constructor Summary

Constructors

Constructor and Description
ContextBo()

Method Summary

Methods

Modifier and Type	Method and Description
ContextBo	copyContext(String additionalNameText)
static ContextBo	from(ContextDefinition im) Converts a immutable object to it's mutable bo counterpart
boolean	getActive()
List<AgendaBo>	getAgendas() Returns the list of agendas AgendaDefinitionContract contained in the context definition.
List<ContextAttributeBo>	getAttributeBos()
Map<String,String>	getAttributes() Returns a map of name/value pairs representing the attributes associated with this context.
String	getDescription() Returns the description of the context definition.
String	getId() The unique identifier for an object.
String	getName() Returns the name of the context definition.
String	getNamespace() Returns the namespace of the context definition.
String	getTypeId() Returns the type id for the context definition.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active)
void	setAgendas(List<AgendaBo> agendas)
void	setAttributeBos(List<ContextAttributeBo> attributeBos)
void	setDescription(String description)
void	setId(String id)
void	setName(String name)
void	setNamespace(String namespace)
void	setTypeId(String typeId)
void	setVersionNumber(Long versionNumber)
static ContextDefinition	to(ContextBo bo) Converts a mutable bo to it's immutable counterpart

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_SEQ_NAME

public static final String CONTEXT_SEQ_NAME

See Also:

Constant Field Values

Constructor Detail

ContextBo

public ContextBo()

Method Detail

getAgendas

public List<AgendaBo> getAgendas()

Description copied from interface: ContextDefinitionContract

Returns the list of agendas AgendaDefinitionContract contained in the context definition. This method should never return null. An empty list is returned if no agendas are associated with this context.

Specified by:

getAgendas in interface ContextDefinitionContract

Returns:

the list of agendas contained in this context definition

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: ContextDefinitionContract

Returns a map of name/value pairs representing the attributes associated with this context.

This method should never return null. An empty map is returned if no attributes are associated with the context.

Specified by:

getAttributes in interface ContextDefinitionContract

Returns:

a list of Map of name/value String pairs.

copyContext

public ContextBo copyContext(String additionalNameText)

to

public static ContextDefinition to(ContextBo bo)

Converts a mutable bo to it's immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object

from

public static ContextBo from(ContextDefinition im)

Converts a immutable object to it's mutable bo counterpart

Parameters:

im - immutable object

Returns:

the mutable bo

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

setId

public void setId(String id)

getName

public String getName()

Description copied from interface: ContextDefinitionContract

Returns the name of the context definition. The combination of name and namespaceCode represent a unique business key for the context definition. The name should never be null or blank.

Specified by:

getName in interface ContextDefinitionContract

Returns:

the name of the context definition, should never be null or blank

setName

public void setName(String name)

getNamespace

public String getNamespace()

Description copied from interface: ContextDefinitionContract

Returns the namespace of the context definition. The combination of namespace and name represent a unique business key for the context definition. The namespace should never be null or blank.

Specified by:

getNamespace in interface ContextDefinitionContract

Returns:

the namespace of the context definition, should never be null or blank

setNamespace

public void setNamespace(String namespace)

getTypeId

public String getTypeId()

Description copied from interface: ContextDefinitionContract

Returns the type id for the context definition. If the type id is null, that means this context definition is of the default type.

Specified by:

getTypeId in interface ContextDefinitionContract

Returns:

the type id for the context definition, or null if this context definition is of the default type

setTypeId

public void setTypeId(String typeId)

getDescription

public String getDescription()

Description copied from interface: ContextDefinitionContract

Returns the description of the context definition.

Specified by:

getDescription in interface ContextDefinitionContract

Returns:

the description of the context definition. May be null.

setDescription

public void setDescription(String description)

getActive

public boolean getActive()

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.

setActive

public void setActive(boolean active)

setAgendas

public void setAgendas(List<AgendaBo> agendas)

getAttributeBos

public List<ContextAttributeBo> getAttributeBos()

setAttributeBos

public void setAttributeBos(List<ContextAttributeBo> attributeBos)

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

setVersionNumber

public void setVersionNumber(Long versionNumber)