org.kuali.rice.krms.api.repository.agenda
Class AgendaDefinition.Builder

java.lang.Object
  org.kuali.rice.krms.api.repository.agenda.AgendaDefinition.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, AgendaDefinitionContract

Enclosing class:

AgendaDefinition

public static class AgendaDefinition.Builder
extends Object
implements AgendaDefinitionContract, ModelBuilder, Serializable

This builder is used to construct instances of KRMS Repository Agenda. It enforces the constraints of the AgendaDefinitionContract.

See Also:

Serialized Form

Method Summary

AgendaDefinition	build() Builds an instance of a Agenda based on the current state of the builder.
static AgendaDefinition.Builder	create(AgendaDefinitionContract contract) Creates a builder by populating it with data from the given AgendaDefinitionContract.
static AgendaDefinition.Builder	create(String id, String name, String namespaceCode, String typeId, String contextId)
Map<String,String>	getAttributes() This method returns a list of attributes associated with the Agenda
String	getContextId()
String	getFirstItemId()
String	getId() This is the ID for the Agenda
String	getName() This is the name of the Agenda
String	getNamespaceCode() This is the namespace of the Agenda
String	getTypeId() This is the KrmsType of the Agenda
void	setAttributes(Map<String,String> attributes)
void	setContextId(String contextId)
void	setFirstItemId(String firstItemId)
void	setId(String agendaId) Sets the value of the id on this builder to the given value.
void	setName(String name)
void	setNamespaceCode(String namespaceCode)
void	setTypeId(String typeId)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AgendaDefinition.Builder create(String id,
                                              String name,
                                              String namespaceCode,
                                              String typeId,
                                              String contextId)

create

public static AgendaDefinition.Builder create(AgendaDefinitionContract contract)

Creates a builder by populating it with data from the given AgendaDefinitionContract.

Parameters:

contract - the contract from which to populate this builder

Returns:

an instance of the builder populated with data from the contract

setId

public void setId(String agendaId)

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

Parameters:

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

Throws:

IllegalArgumentException - if the id is null or blank

setName

public void setName(String name)

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

setTypeId

public void setTypeId(String typeId)

setContextId

public void setContextId(String contextId)

setFirstItemId

public void setFirstItemId(String firstItemId)

setAttributes

public void setAttributes(Map<String,String> attributes)

getId

public String getId()

Description copied from interface: AgendaDefinitionContract

This is the ID for the Agenda

It is a ID of a Agenda

Specified by:

getId in interface AgendaDefinitionContract

Returns:

ID for Agenda

getName

public String getName()

Description copied from interface: AgendaDefinitionContract

This is the name of the Agenda

name - the name of the Agenda

Specified by:

getName in interface AgendaDefinitionContract

Returns:

the name of the Agenda

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: AgendaDefinitionContract

This is the namespace of the Agenda

The namespace of the Agenda

Specified by:

getNamespaceCode in interface AgendaDefinitionContract

Returns:

the namespace of the Agenda

getTypeId

public String getTypeId()

Description copied from interface: AgendaDefinitionContract

This is the KrmsType of the Agenda

Specified by:

getTypeId in interface AgendaDefinitionContract

Returns:

id for KRMS type related of the Agenda

getContextId

public String getContextId()

Specified by:

getContextId in interface AgendaDefinitionContract

getFirstItemId

public String getFirstItemId()

Specified by:

getFirstItemId in interface AgendaDefinitionContract

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: AgendaDefinitionContract

This method returns a list of attributes associated with the Agenda

Specified by:

getAttributes in interface AgendaDefinitionContract

Returns:

a list of AgendaAttribute objects.

build

public AgendaDefinition build()

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

Specified by:

build in interface ModelBuilder

Returns:

the fully-constructed Agenda