|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScanDefinitionManager
Public API for ScanDefinition entity operations.
Method Summary | |
---|---|
ScanDefinitionManagerResult |
create(ScanDefinition definition) Persists a scan definition |
ScanDefinitionManagerResult |
delete(java.lang.String scanDefinitionId) Deletes a scan definition |
ScanDefinition |
getDetails(java.lang.String scanDefinitionID, java.util.Set retAttrs) Retrieves a scan definition object by scanDefinitionId. |
ScanDefinitionManagerResult |
modify(ScanDefinition scanDefinition) Updates a scan definition |
java.util.List |
search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams) Retrieves a list of scan definition objects |
java.util.List |
search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams, boolean includeScanRunCount) Retrieves a list of scan definition objects |
Method Detail |
---|
ScanDefinitionManagerResult create(ScanDefinition definition) throws IDAEngineException, AlreadyExistsException
definition
- entity to storeIDAEngineException
AlreadyExistsException
ScanDefinitionManagerResult delete(java.lang.String scanDefinitionId) throws IDAEngineException
scanDefinitionId
- id of the scan definition to deleteIDAEngineException
- A runtime exception containing information on how to find detailed information in a server log.ScanDefinitionManagerResult modify(ScanDefinition scanDefinition) throws IDAEngineException
scanDefinition
- object to updateIDAEngineException
- A runtime exception containing information on how to find detailed information in a server log.ScanDefinition getDetails(java.lang.String scanDefinitionID, java.util.Set retAttrs) throws IDAEngineException
scanDefinitionID
- id of the scan definition to be retrieved.retAttrs
- scan definition attributes. If retAttrs is not null, the scan definition will be populated only for these attributes.IDAEngineException
- A runtime exception containing information on how to find detailed information in a server log.java.util.List search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams) throws IDAEngineException
criteria
- to retrieve the scan definition objectsretAttrs
- scan definition attributes. If retAttrs is not null, the scan definition will be populated only for these attributesconfigParams
- to specify range of objects and orderingIDAEngineException
- A runtime exception containing information on how to find detailed information in a server log.java.util.List search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams, boolean includeScanRunCount) throws IDAEngineException
criteria
- to retrieve the scan definition objectsretAttrs
- scan definition attributes. If retAttrs is not null, the scan definition will be populated only for these attributes.configParams
- to specify range of objects and orderingincludeScanRunCount
- flag indicating if scan run count is to be included. If true, each scan defintion entity will include the count for the number of scan runs associated with the definition.IDAEngineException
- A runtime exception containing information on how to find detailed information in a server log.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |