Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter
serial class Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter extends EnsPortal.MsgFilter.Filter
Property Inventory (Including Private)
Method Inventory (Including Private)
- DeleteFromSession()
- DeleteFromVirtualSession()
- GetBasicFilter()
- GetReference()
- GetSessionTempNode()
- GetVirtualSessionTempNode()
- HasDefaultVals()
- LoadFromSession()
- LoadFromVirtualSession()
- SaveToSession()
- SaveToVirtualSession()
- SetSessionTempNode()
- SetVirtualSessionTempNode()
Parameters
parameter XMLTYPE = EnterpriseFilter;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type
in a schema and the schema context did not provide an XML type name.
Properties (Including Private)
property ClientIDs as list of %String;
List of client systems to restrict a search to.
Property methods: ClientIDsBuildValueArray(), ClientIDsCollectionToDisplay(), ClientIDsCollectionToOdbc(), ClientIDsDisplayToCollection(), ClientIDsDisplayToLogical(), ClientIDsGet(), ClientIDsGetObject(), ClientIDsGetObjectId(), ClientIDsGetSwizzled(), ClientIDsIsValid(), ClientIDsLogicalToDisplay(), ClientIDsLogicalToOdbc(), ClientIDsNormalize(), ClientIDsOdbcToCollection(), ClientIDsSet(), ClientIDsSetObject(), ClientIDsSetObjectId()
property CurrSystem as %String [ Transient ];
Name of the system currently being traversed when paging through results.
Property methods: CurrSystemDisplayToLogical(), CurrSystemGet(), CurrSystemIsValid(), CurrSystemLogicalToDisplay(), CurrSystemLogicalToOdbc(), CurrSystemNormalize(), CurrSystemSet()
property MaxRows as %Integer (MINVAL = 1) [ InitialExpression = 1000 ];
Number of rows to display. Initialised to 1000 for Enterprise Searches.
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet(), MaxRowsXSDToLogical()
property TempNode as %Integer [ Transient ];
Reference to temporary node ID to use when paging through results.
The value is stored separately from the main Filter to ensure that
new nodes are used each time a query is executed.
Property methods: TempNodeDisplayToLogical(), TempNodeGet(), TempNodeIsValid(), TempNodeLogicalToDisplay(), TempNodeNormalize(), TempNodeSet(), TempNodeXSDToLogical()
property Timeout as %Numeric [ InitialExpression = 2 ];
Timeout to send to the system actually running the query.
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet(), TimeoutXSDToLogical()
Methods (Including Private)
classmethod DeleteFromSession() as %Status [ Language = objectscript ]
Remove the current saved Filter from the CSP session.
Remove the Filter specified by pKey from IRISTEMP.
method GetBasicFilter(Output pFilter As EnsPortal.MsgFilter.Filter) as %Status [ Language = objectscript ]
Helper method to supply an object of type EnsPortal.MsgFilter.Filter
that can be sent to client systems.
classmethod GetReference(pNode As %Integer = 0, pKey As %Integer = 0) as %String [ Language = objectscript ]
classmethod GetSessionTempNode() as %Integer [ Language = objectscript ]
Wrapper method to return the value of the current TempNode ID for this session.
Wrapper method to return the value of the current TempNode ID for this virtual session.
classmethod HasDefaultVals(pFilter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter) as %Boolean [ Language = objectscript ]
classmethod LoadFromSession(Output pFilter As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter) as %Status [ Language = objectscript ]
Deserialise a Filter from the current CSP session, or create a new Filter object
if no serialised data exists.
classmethod LoadFromVirtualSession(ByRef pKey As %Integer = 0, Output pFilter As EnsPortal.MsgFilter.Filter) as %Status [ Language = objectscript ]
Deserialize a Filter from IRISTEMP using the key supplied in pKey.
method SaveToSession() as %Status [ Language = objectscript ]
Serialise the current Filter to the CSP session.
Set property searchIdentifier to the corresponding location pKey, if not set yet.
Serialize the current Filter to IRISTEMP.
Update the current temp node storage in the CSP session.
If a previous node exists for the session, then the data for the old node is cleared.
classmethod SetVirtualSessionTempNode(pNode As %Integer = 0, pKey As %Integer = 0) as %Status [ Language = objectscript ]
Update the current temp node storage in the CSP virtual session.
If a previous node exists for the virtual session, then the data for the old node is cleared.
Inherited Members
Inherited Properties (Including Private)
- ColorBy
- EndId
- EndTime
- GeneratedSQL
- IsError
- SequenceManagerSearch
- SortOrder
- Source
- StartId
- StartTime
- Status
- Target
- Terms
- TimeFormat
- TopCount
- Type
Inherited Methods (Including Private)
- %AddToSaveSet()
- %AddToSyncSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %GetSerial()
- %GetSwizzleObject()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnBeforeAddToSync()
- %OnClose()
- %OnConstructClone()
- %OnDetermineClass()
- %OnJournalObject()
- %OnNew()
- %OnOpen()
- %OnValidateObject()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %SerializeObject()
- %SetModified()
- %SetSerial()
- %SyncObjectIn()
- %SyncTransport()
- %ValidateObject()
- DeleteFromTemp()
- LoadFromTemp()
- LogicalToOdbc()
- NextTerm()
- OdbcToLogical()
- SaveToTemp()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLImportAttributes()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()