com.softwareag.centrasite.api.csom.search
Interface CSOParameter


public interface CSOParameter

This model is used to represent the parameters saved in report search definition. The model contains the following attributes Name - The name of the parameter Type - The type of the parameter isMultiValued - Represent whether this parameter can be have more than one value or single value


Method Summary
 java.lang.String getDisplayName()
           
 java.lang.String getDisplayName(java.util.Locale locale)
           
 java.lang.String getName()
           
 java.lang.String getType()
           
 boolean isMultiValued()
           
 

Method Detail

getName

java.lang.String getName()
Returns:
Returns the name of the parameter.

getDisplayName

java.lang.String getDisplayName()
Returns:
Return the description of the parameter in currently logged in user locale

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)
Returns:
Return the descriptive text for the parameter in the given locale, if locale is null, returns the string in the currently logged in user locale

getType

java.lang.String getType()
Returns:
Returns the type of the report search parameter.

isMultiValued

boolean isMultiValued()
Returns:
Return TRUE if this parameter has more than one value otherwise returns FALSE.