Package com.microstrategy.web.objects

Interface WebChangeJournalSearch

All Superinterfaces:

EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite, WebSearch

All Known Implementing Classes:

WebChangeJournalSearchImpl

public interface WebChangeJournalSearch
extends WebSearch

The WebChangeJournalSearch class represents a change journal search object It allows the user specify the restrictions of the search, including users, machines and so on. And submit searches to the Intelligence Server.

Since:

MicroStrategy Web 9.4.0.

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
WebChangeJournalEntries	getChangeJournalResults()	Attempts to get the change journal results of a search from the Intelligence Server.
void	setAffectedObjects(java.util.List<WebObjectInfo> objects)	Set the restriction about affected objects for the change journal entries that the search returns.
void	setAffectedProjects(java.util.List<WebObjectInfo> projects)	Set the restriction about affected projects for the change journal entries that the search returns.
void	setApplicationTypes(java.util.List<java.lang.Integer> applicationTypes)	Set the restriction about application types for the change journal entries that the search returns.
void	setBeginTime(java.lang.String beginTime)	Set the begin time value for the change journal entries that the search returns.
void	setBeginTransactionID(java.lang.String transactionID)	Set the begin transaction id value for the change journal entries that the search returns.
void	setChangeTypes(java.util.List<java.lang.Integer> changeTypes)	Set the restriction about transaction types for the change journal entries that the search returns.
void	setEndTime(java.lang.String endTime)	Set the end time value for the change journal entries that the search returns.
void	setEndTransactionID(java.lang.String transactionID)	Set the end transaction id value for the change journal entries that the search returns.
void	setMachines(java.util.List<java.lang.String> machines)	Set the restriction about machines for the change journal entries that the search returns.
void	setSessions(java.util.List<java.lang.String> sessions)	Set the restriction about sessions for the change journal entries that the search returns.
void	setTransactionTypes(java.util.List<java.lang.Integer> transactionTypes)	Set the restriction about transaction types for the change journal entries that the search returns.
void	setUsers(java.util.List<WebObjectInfo> users)	Set the restriction about users for the change journal entries that the search returns.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Methods inherited from interface com.microstrategy.web.objects.WebSearch

doSynchronousQuickSearch, doSynchronousQuickSearch, getAbbreviationPattern, getAccessRights, getBlockBegin, getBlockCount, getDescriptionPattern, getDomain, getFirstObjectIndex, getMaxObjects, getMaxWait, getNamePattern, getPollingFrequency, getQuickSearchCertifiedStatus, getQuickSearchDocumentTypes, getQuickSearchEnabledStatus, getQuickSearchMode, getQuickSearchVisibility, getResults, getScope, getSearchExcludeRoots, getSearchFields, getSearchFlags, getSearchID, getSearchOwner, getSearchRoot, getSearchType, getStateClear, getStateSet, getStatus, getTargetUserGroupId, isAsync, isGettingTreeInfo, isQuickSearch, isSynchronousQuickSearch, notUsedBy, notUses, purge, reset, setAbbreviationPattern, setAccessRights, setAsync, setBlockBegin, setBlockCount, setCreatedModifiedByDate, setCreatedModifiedByDate, setCreatedModifiedByInterval, setDescriptionPattern, setDomain, setFirstObjectIndex, setGettingTreeInfo, setMaxObjects, setMaxWait, setNamePattern, setPollingFrequency, setQuickSearch, setQuickSearchCertifiedStatus, setQuickSearchDocumentTypes, setQuickSearchEnabledStatus, setQuickSearchMode, setQuickSearchVisibility, setScope, setSearchFields, setSearchFlags, setSearchID, setSearchOwner, setSearchRoot, setSearchType, setStateClear, setStateSet, setTargetUserGroupId, submit, submit, types, usedBy, usedBy, uses, uses

Method Detail

setUsers

void setUsers(java.util.List<WebObjectInfo> users)

Set the restriction about users for the change journal entries that the search returns.

Parameters:

users - . A list of the users that used to filter the change journal result.

setMachines

void setMachines(java.util.List<java.lang.String> machines)

Set the restriction about machines for the change journal entries that the search returns.

Parameters:

machines - . A list of the machine names that used to filter the change journal result.

setSessions

void setSessions(java.util.List<java.lang.String> sessions)

Set the restriction about sessions for the change journal entries that the search returns.

Parameters:

sessions - . A list of the sessions that used to filter the change journal result.

setAffectedObjects

void setAffectedObjects(java.util.List<WebObjectInfo> objects)

Set the restriction about affected objects for the change journal entries that the search returns.

Parameters:

objects - . A list of the affected objects that used to filter the change journal result.

setAffectedProjects

void setAffectedProjects(java.util.List<WebObjectInfo> projects)

Set the restriction about affected projects for the change journal entries that the search returns.

Parameters:

projects - . A list of the projects that used to filter the change journal result.

setTransactionTypes

void setTransactionTypes(java.util.List<java.lang.Integer> transactionTypes)

Set the restriction about transaction types for the change journal entries that the search returns.

Parameters:

transactionTypes - . A list of the transaction types that used to filter the change journal result.

setChangeTypes

void setChangeTypes(java.util.List<java.lang.Integer> changeTypes)

Set the restriction about transaction types for the change journal entries that the search returns.

Parameters:

changeTypes - . A list of the change types that used to filter the change journal result.

setApplicationTypes

void setApplicationTypes(java.util.List<java.lang.Integer> applicationTypes)

Set the restriction about application types for the change journal entries that the search returns.

Parameters:

applicationTypes - . A list of the application types that used to filter the change journal result.

setBeginTime

void setBeginTime(java.lang.String beginTime)

Set the begin time value for the change journal entries that the search returns.

Parameters:

beginTime - . The begin time of the change journal search restriction.

setEndTime

void setEndTime(java.lang.String endTime)

Set the end time value for the change journal entries that the search returns.

Parameters:

endTime - . The end time of the change journal search restriction.

setBeginTransactionID

void setBeginTransactionID(java.lang.String transactionID)

Set the begin transaction id value for the change journal entries that the search returns.

Parameters:

transactionID - . The begin transaction id of the change journal search restriction.

setEndTransactionID

void setEndTransactionID(java.lang.String transactionID)

Set the end transaction id value for the change journal entries that the search returns.

Parameters:

transactionID - . The end transaction id of the change journal search restriction.

getChangeJournalResults

WebChangeJournalEntries getChangeJournalResults()
                                         throws WebObjectsException

Attempts to get the change journal results of a search from the Intelligence Server. The search ID used will be the one set on this WebChangeJournalSearch object.

Returns:

A WebChangeJournalEntries object representing the collection of WebChangeJournalEntry returned from the search, or null if the search is not yet ready.

Throws:

WebObjectsException - Signals an error in the execution or retrieval of results of the search.