com.softwareag.centrasite.api.csom.search.validation
Interface CSOValidationInfo


public interface CSOValidationInfo

CSOValidationInfo captures the information about the error prone Search elements and severity of the error prone.


Method Summary
 CSOSearchCondition getCondition()
          provides the problematic CSOSearchCondition object if present, else returns null.
 java.lang.String getInfoType()
          validation Info Type which helps to understand the level of the validation error i.e ERROR, WARNING
 java.lang.String getMessage()
          the detailed message describes about the the validation error.
 CentraSiteObjectAttribute getResultAttribute()
          provides the problematic CentraSiteObjectAttribute if present in the result attributes, else return null.
 CSOSearchScope getScope()
          provides the problematic CSOSearchScope in the search if present, else returns null.
 CSOSortSpecifier getSortSpecifier()
          provides the problematic CSOSortSpecifier else return null.
 

Method Detail

getMessage

java.lang.String getMessage()
the detailed message describes about the the validation error.

Returns:
the detailed message describes about the the validation error.

getInfoType

java.lang.String getInfoType()
validation Info Type which helps to understand the level of the validation error i.e ERROR, WARNING

Returns:
info type like ERROR, WARNING, which describes the level of the validation error.

getScope

CSOSearchScope getScope()
provides the problematic CSOSearchScope in the search if present, else returns null.

Returns:
the problematic CSOSearchScope in the search if present, else returns null.

getCondition

CSOSearchCondition getCondition()
provides the problematic CSOSearchCondition object if present, else returns null.

Returns:
the problematic CSOSearchCondition object if present, else returns null.

getResultAttribute

CentraSiteObjectAttribute getResultAttribute()
provides the problematic CentraSiteObjectAttribute if present in the result attributes, else return null.

Returns:
the problematic CentraSiteObjectAttribute if present in the result attributes, else return null.

getSortSpecifier

CSOSortSpecifier getSortSpecifier()
provides the problematic CSOSortSpecifier else return null.

Returns:
the problematic CSOSortSpecifier else return null.