com.clra.web
Interface IMemberNameList

All Superinterfaces:

INameList

public interface IMemberNameList

extends INameList

Declares JSP attributes and bean properties for alphabetized lists of members. Views that implement this interface may be controlled via components such as NameSelector. This interface is an extension of INameList.

For Java Server Pages, this interface declares one attribute (in addition to the attributes declared by INameList) that should be set and accessed within the scope of a request or session:

• membernameformat: the format with which member names are presented and sorted. [MemberNameFormat.FIRSTLAST]

For beans, this interface declares one property (in addition to the properties declared by INameList):

• memberNameFormat: read/write MemberNameFormat

Version:

$Revision: 1.2 $ $Date: 2002/02/18 18:06:03 $

Author:

Rick Hall

Field Summary

static String

AN_MEMBERNAMEFORMAT Names an attribute within the scope of an HTTP request or session that determines how member names are presented and sorted.

Fields inherited from interface com.clra.web.INameList

AN_COMPARATOR, AN_GROUP, AN_ISRESTRICTED

Method Summary

MemberNameFormat	getMemberNameFormat() Returns a String that indicates whether an iterator will be sorted by first or last name.
void	setMemberNameFormat(MemberNameFormat memberNameFormat) Sets whether an iterator will be sorted by first or last name.

Methods inherited from interface com.clra.web.INameList

getComparator, getGroup, getIterator, getRestricted, setComparator, setGroup, setRestricted

Field Detail

AN_MEMBERNAMEFORMAT

public static final String AN_MEMBERNAMEFORMAT

Names an attribute within the scope of an HTTP request or session that determines how member names are presented and sorted. The value of this attribute should be an instance of MemberNameFormat. A null value indicates the default, MemberNameFormat.FIRSTLAST.

Method Detail

getMemberNameFormat

public MemberNameFormat getMemberNameFormat()

Returns a String that indicates whether an iterator will be sorted by first or last name.

Returns:

FIRST or LAST.

setMemberNameFormat

public void setMemberNameFormat(MemberNameFormat memberNameFormat)

Sets whether an iterator will be sorted by first or last name. The argument can not be null. The argument is trimmed of any leading or trailing whitespace, then compared in a case-insensitive manner to FIRST and LAST. If the normalized value matches either, then that value is set. Otherwise an IllegalArgumentException is thrown.