com.sas.servlet.tbeans.remotefileselector2
Class RemoteFileSearchFieldsAttributes

com.sas.servlet.tbeans.remotefileselector2.RemoteFileSearchFieldsAttributes

public class RemoteFileSearchFieldsAttributes

This class is used to save the last values of the search fields of the RemoteFileSearch class.

Field Summary

static java.lang.String	CREATED_DATE used to specify the created date when searching on datetime values
static java.lang.String	MODIFIED_DATE used to specify the modified date when searching on datetime values
static java.lang.String	NO_DATE used to specify that no date or time should be used for searching

Constructor Summary

RemoteFileSearchFieldsAttributes()

Method Summary

java.lang.String	getDateSearchType() Returns the set date type to be used for searching.
java.lang.String	getDateTimeUnit() Returns the relateive date time unit.
java.util.Date	getEndingDate() Returns the max date to use for searching.
boolean	getRecursive() Returns the setting of the recursive search flag.
java.lang.String	getRelativeDateTimeValue() Returns teh relative date specified on the client
java.lang.String	getSearchContext() Returns the search context or column.
RemoteFileSearchAttributes	getSearchModelAttributes() Returns the object that contains the values required by the search model for performing a search
java.lang.String	getSearchText() Returns the text used for searching.
java.util.Date	getStartingDate() Returns the currently set value of the starting date range.
java.lang.String	getStartingLocation() Returns the search starting location
boolean	isContentUpdateMode() Returns the ContentUpdateMode for the search parameters.
void	setContentUpdateMode(boolean updateMode) Indicates update status of the search parameters.
void	setDateSearchType(java.lang.String dateType) Sets a value indicating whether a date is used or not.
void	setEndingDate(java.util.Date endDateTime) Sets the ending date time for the search
void	setRecursive(boolean recursive) Sets the value for searching of subfolders
void	setRelativeDateTimeUnit(java.lang.String dateTimeUnit) Sets the relative date time unit.
void	setRelativeDateTimeValue(java.lang.String dateTimeValue) Sets the relative date specified on the client
void	setSearchContext(java.lang.String searchContext) Sets the context or column that is searched.
void	setSearchModelAttributes(RemoteFileSearchAttributes modelSearchCriteria) Sets the object that will store the model attributes required by the search model's loadFileInfo used for performing the search.
void	setSearchText(java.lang.String searchText) Sets the text used for searching.
void	setStartingDate(java.util.Date startDateTime) Sets the search starting date time.
void	setStartingLocation(java.lang.String path) Sets the starting location to use for searching.

Field Detail

MODIFIED_DATE

public static final java.lang.String MODIFIED_DATE

used to specify the modified date when searching on datetime values

See Also:

Constant Field Values

CREATED_DATE

public static final java.lang.String CREATED_DATE

used to specify the created date when searching on datetime values

See Also:

Constant Field Values

NO_DATE

public static final java.lang.String NO_DATE

used to specify that no date or time should be used for searching

See Also:

Constant Field Values

Constructor Detail

RemoteFileSearchFieldsAttributes

public RemoteFileSearchFieldsAttributes()

Method Detail

setSearchModelAttributes

public void setSearchModelAttributes(RemoteFileSearchAttributes modelSearchCriteria)

Sets the object that will store the model attributes required by the search model's loadFileInfo used for performing the search.

Parameters:

search - attribute values returned from the model

See Also:

getSearchModelAttributes(), The RemoteFileSearchAttributes class

getSearchModelAttributes

public RemoteFileSearchAttributes getSearchModelAttributes()

Returns the object that contains the values required by the search model for performing a search

Returns:

search model attributes

See Also:

setSearchModelAttributes(RemoteFileSearchAttributes)

setSearchText

public void setSearchText(java.lang.String searchText)

Sets the text used for searching.

Parameters:

searchText - the text item to be searched

getSearchText

public java.lang.String getSearchText()

Returns the text used for searching.

Returns:

the text item

setSearchContext

public void setSearchContext(java.lang.String searchContext)

Sets the context or column that is searched.

Parameters:

searchContext - the column identifier

getSearchContext

public java.lang.String getSearchContext()

Returns the search context or column.

Returns:

the column identifier to be searched

setRecursive

public void setRecursive(boolean recursive)

Sets the value for searching of subfolders

Parameters:

recursive - searching of subfolders

getRecursive

public boolean getRecursive()

Returns the setting of the recursive search flag.

Returns:

true is returned if the search sub folders flag is to be selected

setStartingLocation

public void setStartingLocation(java.lang.String path)

Sets the starting location to use for searching.

Parameters:

search - starting location

getStartingLocation

public java.lang.String getStartingLocation()

Returns the search starting location

Returns:

the path location

setStartingDate

public void setStartingDate(java.util.Date startDateTime)

Sets the search starting date time.

Parameters:

startDateTime -

getStartingDate

public java.util.Date getStartingDate()

Returns the currently set value of the starting date range.

Returns:

the starting date

setEndingDate

public void setEndingDate(java.util.Date endDateTime)

Sets the ending date time for the search

Parameters:

endDateTime - ending date

getEndingDate

public java.util.Date getEndingDate()

Returns the max date to use for searching.

Returns:

the ending date

setDateSearchType

public void setDateSearchType(java.lang.String dateType)

Sets a value indicating whether a date is used or not. If the date is used then the type indicates whether the date is a MODIFIED_DATE or a CREATED_DATE. If NO_DATE is specified then no date or time will be used for searching.

Parameters:

dateType - the date type

getDateSearchType

public java.lang.String getDateSearchType()

Returns the set date type to be used for searching.

Returns:

the date type

setRelativeDateTimeValue

public void setRelativeDateTimeValue(java.lang.String dateTimeValue)

Sets the relative date specified on the client

Parameters:

dateTimeValue -

getRelativeDateTimeValue

public java.lang.String getRelativeDateTimeValue()

Returns teh relative date specified on the client

Returns:

setRelativeDateTimeUnit

public void setRelativeDateTimeUnit(java.lang.String dateTimeUnit)

Sets the relative date time unit. The valid values are Hours, Days, Weeks and Months

Parameters:

dateTimeUnit -

getDateTimeUnit

public java.lang.String getDateTimeUnit()

Returns the relateive date time unit.

Returns:

Hours is returned by default

setContentUpdateMode

public void setContentUpdateMode(boolean updateMode)

Indicates update status of the search parameters. The viewer values are updated based on the status of this flag. After the parameter values are updated the ContentUpdateMode is set to false.

When a SearchCommand is executed the contents of the parameters are updated. Otherwise the contents of the search parameters remain set to their current values.

Parameters:

updateMode - true when a StartSearchCommand is executed and set to false once the parameters are updated

See Also:

isContentUpdateMode()

isContentUpdateMode

public boolean isContentUpdateMode()

Returns the ContentUpdateMode for the search parameters.

Returns:

ContentUpdateMode for the the search parameters, this value is false by default

See Also:

setContentUpdateMode(boolean)