org.kuali.student.lum.statement.config.context.util
Class NLCluSet

java.lang.Object
  org.kuali.student.lum.statement.config.context.util.NLCluSet

public class NLCluSet
extends Object

Warning
DO NOT change the public method signatures of this class.
The natural language templates are coded against this class's public methods. If the method signatures are changed then all the templates referencing this class will need to be changed as well.

This class is inserted into the template engine to get Clu and CluSet information. $cluSet is this class.

Example: "Student must have completed $intValue of $cluSet.getCluSetAsShortName()"

MockCluSetInfo wrapper class.

Field Summary

private List<CluInfo>	cluList
private CluSetInfo	cluSet
private String	cluSetId

Constructor Summary

NLCluSet(String cluSetId, List<CluInfo> cluList)

NLCluSet(String cluSetId, List<CluInfo> cluList, CluSetInfo cluSet)

Method Summary

String	getCluAsCode(int index) Gets a particular CLU's official identifier code at index
String	getCluAsShortName(int index) Gets a particular CLU's official identifier short name.
List<CluInfo>	getCluList() Gets a list of CLUs.
String	getCluSetAsCode() Gets all the CLUs' official identifier code in the CLU set as a comma separated list.
String	getCluSetAsCode(String separator) Gets all the CLUs' official identifier code in the CLU set as a list of values separated by the specified separator.
String	getCluSetAsLongName() Gets all the CLUs' official identifier long name in the CLU set as a comma separated list.
String	getCluSetAsLongName(String separator) Gets all the CLUs' official identifier long name in the CLU set as a list of values separated by the specified separator.
String	getCluSetAsShortName() Gets all the CLUs' official identifier short name in the CLU set as a comma separated list.
String	getCluSetAsShortName(String separator) Gets all the CLUs' official identifier short name in the CLU set as a list of values separated by the specified separator.
String	getCluSetId() Gets the CLU set id.
String	getQueryValueFromParam(String param)
private String	getString(StringBuilder sb)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

cluSetId

private String cluSetId

cluList

private List<CluInfo> cluList

cluSet

private CluSetInfo cluSet

Constructor Detail

NLCluSet

public NLCluSet(String cluSetId,
                List<CluInfo> cluList)

NLCluSet

public NLCluSet(String cluSetId,
                List<CluInfo> cluList,
                CluSetInfo cluSet)

Method Detail

getCluSetId

public String getCluSetId()

Gets the CLU set id.

Returns:

Clu set id

getCluList

public List<CluInfo> getCluList()

Gets a list of CLUs.

Returns:

List of CLUs

getCluAsShortName

public String getCluAsShortName(int index)

Gets a particular CLU's official identifier short name.

Parameters:

index - Index in CLU set

Returns:

CLU official identifier short name

getCluAsCode

public String getCluAsCode(int index)

Gets a particular CLU's official identifier code at index

Parameters:

index -

Returns:

CLU's official identifier code

getCluSetAsShortName

public String getCluSetAsShortName()

Gets all the CLUs' official identifier short name in the CLU set as a comma separated list.

Returns:

Comma separated list of CLUs' official identifier short name

getCluSetAsShortName

public String getCluSetAsShortName(String separator)

Gets all the CLUs' official identifier short name in the CLU set as a list of values separated by the specified separator.

Parameters:

The - string value that is used to separate the values in the list.

Returns:

Character separated list of CLUs' official identifier short name

getCluSetAsLongName

public String getCluSetAsLongName()

Gets all the CLUs' official identifier long name in the CLU set as a comma separated list.

Returns:

Comma separated list of CLUs' official identifier long name

getCluSetAsLongName

public String getCluSetAsLongName(String separator)

Gets all the CLUs' official identifier long name in the CLU set as a list of values separated by the specified separator.

Parameters:

separator - The string value that is used to separate the values in the list.

Returns:

Character separated list of CLUs' official identifier long name

getCluSetAsCode

public String getCluSetAsCode()

Gets all the CLUs' official identifier code in the CLU set as a comma separated list.

Returns:

Comma separated list of CLUs' official identifier code

getCluSetAsCode

public String getCluSetAsCode(String separator)

Gets all the CLUs' official identifier code in the CLU set as a list of values separated by the specified separator.

Parameters:

separator - The string value that is used to separate the values in the list.

Returns:

Character separated list of CLUs' official identifier code

getString

private String getString(StringBuilder sb)

toString

public String toString()

Overrides:

toString in class Object

getQueryValueFromParam

public String getQueryValueFromParam(String param)