AgendaBoService

• createAgenda
• updateAgenda
• getAgendaByAgendaId
• getAgendaByNameAndContextId
• getAgendasByContextId
• createAgendaItem
• updateAgendaItem
• addAgendaItem
• getAgendaItemById
• to
• from

• AgendaDefinition
• void
• AgendaItemDefinition
• AgendaBo

Method	createAgenda
Description	This will create a {@link AgendaDefinition} exactly like the parameter passed in.
Parameters	AgendaDefinition	agenda	The Agenda to create
Return	AgendaDefinition		???
Errors	NONE		No Errors

Back to Operations

Method	updateAgenda
Description	This will update an existing {@link AgendaDefinition}.
Parameters	AgendaDefinition	agenda	The Agenda to update
Return	void		???
Errors	NONE		No Errors

Back to Operations

Method	getAgendaByAgendaId
Description	Retrieves an Agenda from the repository based on the given agenda id.
Parameters	String	agendaId	the id of the Agenda to retrieve
Return	AgendaDefinition		an {@link AgendaDefinition} identified by the given agendaId. A null reference is returned if an invalid or non-existent id is supplied.
Errors	NONE		No Errors

Back to Operations

Method	getAgendaByNameAndContextId
Description	Retrieves an Agenda from the repository based on the provided agenda name and context id.
Parameters	String	name	the name of the Agenda to retrieve.
	String	contextId	the id of the context that the agenda belongs to.
Return	AgendaDefinition		an {@link AgendaDefinition} identified by the given name and namespace. A null reference is returned if an invalid or non-existent name and namespace combination is supplied.
Errors	NONE		No Errors

Back to Operations

Method	getAgendasByContextId
Description	Retrieves a set of Agendas associated with a context.
Parameters	String	contextId	the id of the context
Return	AgendaDefinitionList		a set of {@link AgendaDefinition} associated with the given context. A null reference is returned if an invalid or contextId is supplied.
Errors	NONE		No Errors

Back to Operations

Method	createAgendaItem
Description	This will create an {@link org.kuali.rice.krms.api.repository.agenda.AgendaItemDefinition} in the repository exactly like the parameter passed in.
Parameters	AgendaItemDefinition	agendaItem	The AgendaItemDefinition to create
Return	AgendaItemDefinition		???
Errors	NONE		No Errors

Back to Operations

Method	updateAgendaItem
Description	This will update an existing {@link org.kuali.rice.krms.api.repository.agenda.AgendaItemDefinition}.
Parameters	AgendaItemDefinition	agendaItem	The AgendaItemDefinition to update
Return	void		???
Errors	NONE		No Errors

Back to Operations

Method	addAgendaItem
Description	This will create an {@link org.kuali.rice.krms.api.repository.agenda.AgendaItemDefinition} in the repository exactly like the parameter passed in. The AgendaItemDefinition will be linked to an existing AgendaItemDefinition in the relationship provided. Linking the AgendaItems effectively builds a tree of AgendaItems that may be traversed by the engine.
Parameters	AgendaItemDefinition	agendaItem	The AgendaItemDefinition to create
	String	parentId	The id of the existing AgendaItemDefinition to be linked with the newly created AgendaItemDefinition
	Boolean	position	???
Return	void		???
Errors	NONE		No Errors

Back to Operations

Method	getAgendaItemById
Description	Retrieves an AgendaItemDefinition from the repository based on the given agenda id.
Parameters	String	id	the id of the AgendaItemDefinition to retrieve
Return	AgendaItemDefinition		an {@link org.kuali.rice.krms.api.repository.agenda.AgendaItemDefinition} identified by the given id. A null reference is returned if an invalid or non-existent id is supplied.
Errors	NONE		No Errors

Back to Operations

Method	to
Description	Converts a mutable bo to it's immutable counterpart
Parameters	AgendaBo	bo	the mutable business object
Return	AgendaDefinition		the immutable object
Errors	NONE		No Errors

Back to Operations

Method	from
Description	Converts a immutable object to it's mutable bo counterpart
Parameters	AgendaDefinition	im	immutable object
Return	AgendaBo		the mutable bo
Errors	NONE		No Errors

Back to Operations