OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.TriggerEnablerQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among TriggerEnabler objects. The search query is constructed using the TriggerEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated system view: searches include trigger enablers in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to trigger enablers in this system

Device constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the TriggerEnablerQuery.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchTriggerEnablers
Description

Tests if this user can perform TriggerEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedSystemView
Description

Federates the view for methods in this session. A federated view will include trigger enablers in systems which are children of this broker in the system hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

CompliancemandatoryThis method is must be implemented.
MethodgetTriggerEnablerQuery
Description

Gets a trigger enabler query.

Returnosid.control.rules.TriggerEnablerQuerythe trigger enabler query
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablersByQuery
Description

Gets a list of TriggerEnablers matching the given search.

Parametersosid.control.rules.TriggerEnablerQuerytriggerEnablerQuerythe device constraienr enabler query
Returnosid.control.rules.TriggerEnablerListthe returned TriggerEnablerList
ErrorsNULL_ARGUMENT triggerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED triggerEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.