org.kuali.kra.irb.protocol.participant

Class ParticipantTypeValuesFinder

java.lang.Object

org.kuali.rice.krad.keyvalues.KeyValuesBase

org.kuali.kra.irb.protocol.participant.ParticipantTypeValuesFinder

All Implemented Interfaces:

Serializable, org.kuali.rice.krad.keyvalues.KeyValuesFinder

public class ParticipantTypeValuesFinder
extends org.kuali.rice.krad.keyvalues.KeyValuesBase

Finds the available set of supported Participant Types. See the method getKeyValues() for a full description.

Author:

Kuali Research Administration Team (kc.dev@kuali.org)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParticipantTypeValuesFinder()

Method Summary

Methods

Modifier and Type	Method and Description
List<org.kuali.rice.core.api.util.KeyValue>	getKeyValues() Constructs the list of Protocol Participant Types.

Methods inherited from class org.kuali.rice.krad.keyvalues.KeyValuesBase

clearInternalCache, getKeyLabel, getKeyLabelMap, getKeyValues, getOptionLabels, getOptionValues

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticipantTypeValuesFinder

public ParticipantTypeValuesFinder()

Method Detail

getKeyValues

public List<org.kuali.rice.core.api.util.KeyValue> getKeyValues()

Constructs the list of Protocol Participant Types. Each entry in the list is a <key, value> pair, where the "key" is the unique type code and the "value" is the textual description that is viewed by a user. The list is obtained from the Participant Type database table via the "keyValuesService". The intent of this method is to provide a list which is viewed in a GUI. As such, the first entry in the list is the generic <"", "select:"> option.

The list is also filtered based upon the participants currently in the protocol document. Users are not allowed to create two or more participants with the same participant type. Therefore, if an participant type is already being used, it is removed from the list. If the document cannot be found, the entire list is returned (it is not filtered).

Returns:

the list of <key, value> pairs of participant types. The first entry is always <"", "select:">.

See Also:

org.kuali.core.lookup.keyvalues.KeyValuesFinder#getKeyValues()