Class SubjectStatusConfig
java.lang.Object
edu.internet2.middleware.subject.provider.SubjectStatusConfig
config for a source of the status params
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionsource id for exceptionscolumn or attribute which represents the statusavailable statuses from screen (if not specified, any will be allowed). comma separated listsearch string from user which represents the status.if no status is specified, this will be used (e.g. for active only).translate between screen values of status, and the data store value.booleanvoidsetSourceId(String sourceId1) source id for exceptionsvoidsetStatusAllFromUser(String statusAllFromUser1) voidsetStatusDatastoreFieldName(String statusDatastoreFieldName1) column or attribute which represents the statusvoidsetStatusLabel(String statusLabel1) search string from user which represents the status.voidsetStatusSearchDefault(String statusSearchDefault1) if no status is specified, this will be used (e.g. for active only).voidvalidate()see if the configuration is ok for this source
-
Constructor Details
-
SubjectStatusConfig
public SubjectStatusConfig()default constructor -
SubjectStatusConfig
- Parameters:
source-
-
-
Method Details
-
isStatusConfigured
public boolean isStatusConfigured()- Returns:
- the status
-
getSourceId
source id for exceptions- Returns:
- source id
-
setSourceId
source id for exceptions- Parameters:
sourceId1-
-
validate
public void validate()see if the configuration is ok for this source -
getStatusDatastoreFieldName
column or attribute which represents the status- Returns:
- column or attribute
-
setStatusDatastoreFieldName
column or attribute which represents the status- Parameters:
statusDatastoreFieldName1-
-
getStatusLabel
search string from user which represents the status. e.g. status=active- Returns:
- label
-
setStatusLabel
search string from user which represents the status. e.g. status=active- Parameters:
statusLabel1-
-
getStatusesFromUser
available statuses from screen (if not specified, any will be allowed). comma separated list- Returns:
- status
-
getStatusAllFromUser
- Returns:
-
setStatusAllFromUser
- Parameters:
statusAllFromUser1-
-
getStatusSearchDefault
if no status is specified, this will be used (e.g. for active only). Note, the value should be of the form the user would type in, e.g. status=active- Returns:
- status search default
-
setStatusSearchDefault
if no status is specified, this will be used (e.g. for active only). Note, the value should be of the form the user would type in, e.g. status=active- Parameters:
statusSearchDefault1-
-
getStatusTranslateUserToDatastore
translate between screen values of status, and the data store value. Increment the 0 to 1, 2, etc for more translations. so the user could enter: status=active, and that could translate to status_col=A. The 'user' is what the user types in, the 'datastore' is what is in the datastore. The user part is not case-sensitive. Note, this could be a many to one . The key is what the user types in, the value is what goes to the database- Returns:
- the translation
-