Class actuate.reportexplorer.FileSearch

Represents a JavaScript version of com.actuate.schemas.FileSearch.
Member of: actuate.reportexplorer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.reportexplorer.FileSearch() Constructs a FileSearch object to use wildcard conditions to find a file.

Method Summary
Method Attributes	Method Name and Description
	getAccessType() Gets the accessType value for this FileSearch.
	getCondition() Gets the condition value for this FileSearch.
	getConditionArray() Gets the conditionArray value for this FileSearch.
	getCountLimit() Gets the countLimit value for this FileSearch.
	getDependentFileId() Gets the dependentFileId value for this FileSearch.
	getDependentFileName() Gets the dependentFileName value for this FileSearch.
	getFetchDirection() Gets the fetchDirection value for this FileSearch.
	getFetchHandle() Gets the fetchHandle value for this FileSearch.
	getFetchSize() Gets the fetchSize value for this FileSearch.
	getIncludeHiddenObject() Gets the includeHiddenObject value for this FileSearch.
	getOwner() Gets the owner value for this FileSearch.
	getPrivilegeFilter() Gets the privilegeFilter value for this FileSearch.
	getRequiredFileId() Gets the requiredFileId value for this FileSearch.
	getRequiredFileName() Gets the requiredFileName value for this FileSearch.
	setAccessType(accessType) Sets the accessType value for this FileSearch.
	setCondition(condition) Sets the condition value for this FileSearch.
	setConditionArray(conditionArray) Sets the conditionArray value for this FileSearch.
	setCountLimit(countLimit) Sets the countLimit value for this FileSearch.
	setDependentFileId(dependentFileId) Sets the dependentFileId value for this FileSearch.
	setDependentFileName(dependentFileName) Sets the dependentFileName value for this FileSearch.
	setFetchDirection(fetchDirection) Sets the fetchDirection value for this FileSearch.
	setFetchHandle(fetchHandle) Sets the fetchHandle value for this FileSearch.
	setFetchSize(fetchSize) Sets the fetchSize value for this FileSearch.
	setIncludeHiddenObject(includeHiddenObject) Sets the includeHiddenObject value for this FileSearch.
	setOwner(owner) Sets the owner value for this FileSearch.
	setPrivilegeFilter(privilegeFilter) Sets the privilegeFilter value for this FileSearch.
	setRequiredFileId(requiredFileId) Sets the requiredFileId value for this FileSearch.
	setRequiredFileName(requiredFileName) Sets the requiredFileName value for this FileSearch.

Class Detail

actuate.reportexplorer.FileSearch()

Constructs a FileSearch object to use wildcard conditions to find a file.

Method Detail

getAccessType()

Gets the accessType value for this FileSearch. Possible values are: "Private", "Shared"

Returns:: accessType {String}

getCondition()

Gets the condition value for this FileSearch.

Returns:: condition {FileCondition} Object of type actuate.reportexplorer.FileCondition

See:: actuate.reportexplorer.FileCondition

getConditionArray()

Gets the conditionArray value for this FileSearch.

Returns:: conditionArray {ArrayOfFileCondition} Array of objects of type actuate.reportexplorer.FileCondition

See:: actuate.reportexplorer.FileCondition

getCountLimit()

Gets the countLimit value for this FileSearch.

Returns:: countLimit {Integer}

getDependentFileId()

Gets the dependentFileId value for this FileSearch.

Returns:: dependentFileId {String}

getDependentFileName()

Gets the dependentFileName value for this FileSearch.

Returns:: dependentFileName {String}

getFetchDirection()

Gets the fetchDirection value for this FileSearch.

Returns:: fetchDirection {boolean}

getFetchHandle()

Gets the fetchHandle value for this FileSearch.

Returns:: fetchHandle {String}

getFetchSize()

Gets the fetchSize value for this FileSearch.

Returns:: fetchSize {Integer}

getIncludeHiddenObject()

Gets the includeHiddenObject value for this FileSearch.

Returns:: includeHiddenObject {boolean}

getOwner()

Gets the owner value for this FileSearch.

Returns:: owner {String}

getPrivilegeFilter()

Gets the privilegeFilter value for this FileSearch.

Returns:: privilegeFilter {previlegeFilter} Object of type actuate.reportexplorer.PrivilegeFilter

See:: actuate.reportexplorer.PrivilegeFilter

getRequiredFileId()

Gets the requiredFileId value for this FileSearch.

Returns:: requiredFileId {String}

getRequiredFileName()

Gets the requiredFileName value for this FileSearch.

Returns:: requiredFileName {String}

{void} setAccessType(accessType)

Sets the accessType value for this FileSearch.

Parameters:
accessType: Possible values are: "Private", "Shared"

Returns:: {void}

{void} setCondition(condition)

Sets the condition value for this FileSearch.

Parameters:
condition: {FileCondition} Object of type actuate.reportexplorer.FileCondition

Returns:: {void}

See:: actuate.reportexplorer.FileCondition

setConditionArray(conditionArray)

Sets the conditionArray value for this FileSearch.

Parameters:
conditionArray: {ArrayOfFileCondition} Array of objects of type actuate.reportexplorer.FileCondition

See:: actuate.reportexplorer.FileCondition

{void} setCountLimit(countLimit)

Sets the countLimit value for this FileSearch.

Parameters:
countLimit: {Integer}

Returns:: {void} )

{void} setDependentFileId(dependentFileId)

Sets the dependentFileId value for this FileSearch.

Parameters:
dependentFileId: {String}

Returns:: {void}

{void} setDependentFileName(dependentFileName)

Sets the dependentFileName value for this FileSearch.

Parameters:
dependentFileName: {String}

Returns:: {void}

{void} setFetchDirection(fetchDirection)

Sets the fetchDirection value for this FileSearch.

Parameters:
fetchDirection: {boolean}

Returns:: {void}

{void} setFetchHandle(fetchHandle)

Sets the fetchHandle value for this FileSearch.

Parameters:
fetchHandle: {String}

Returns:: {void}

setFetchSize(fetchSize)

Sets the fetchSize value for this FileSearch.

Parameters:
fetchSize: {Integer}

{void} setIncludeHiddenObject(includeHiddenObject)

Sets the includeHiddenObject value for this FileSearch.

Parameters:
includeHiddenObject: {boolean}

Returns:: {void}

{void} setOwner(owner)

Sets the owner value for this FileSearch.

Parameters:
owner: {String}

Returns:: {void}

setPrivilegeFilter(privilegeFilter)

Sets the privilegeFilter value for this FileSearch.

Parameters:
privilegeFilter: {PrivilegeFilter} Object of type actuate.reportexplorer.PrivilegeFilter

See:: actuate.reportexplorer.PrivilegeFilter

{void} setRequiredFileId(requiredFileId)

Sets the requiredFileId value for this FileSearch.

Parameters:
requiredFileId: {String}

Returns:: {void}

{void} setRequiredFileName(requiredFileName)

Sets the requiredFileName value for this FileSearch.

Parameters:
requiredFileName

Returns:: {void}

Classes

Class actuate.reportexplorer.FileSearch