AuditProcessorEnabler

All Superinterfaces:: Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface AuditProcessorEnabler extends OsidEnabler

An AuditProcessorEnabler manages the active status of an AuditProcessor..

Like all OsidObjects, AuditProcessorEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type

Method

Description

AuditProcessorEnablerRecord

getAuditProcessorEnablerRecord(Type auditProcessorEnablerRecordType)

Gets the audit processor enabler record corresponding to the given AuditProcessorEnabler record Type.

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface Identifiable
getId, isCurrent

Methods inherited from interface Operable
isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface OsidEnabler
getCyclicEvent, getCyclicEventId, getCyclicTimePeriod, getCyclicTimePeriodId, getEvent, getEventId, getSchedule, getScheduleId, getTimePeriod, getTimePeriodId, isOperationalDuringCyclicEvent, isOperationalDuringCyclicTimePeriod, isOperationalDuringEvent, isOperationalDuringTimePeriod, isOperationalOnSchedule, isRequirement

Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface OsidRule
getConditionRecordTypes, getRule, getRuleId, hasRule

Methods inherited from interface Temporal
getEndDate, getStartDate, isEffective

Method Details
- getAuditProcessorEnablerRecord
  
  AuditProcessorEnablerRecord getAuditProcessorEnablerRecord(Type auditProcessorEnablerRecordType) throws OperationFailedException
  
  Gets the audit processor enabler record corresponding to the given AuditProcessorEnabler record Type. This method ie used to retrieve an object implementing the requested record. The auditProcessorEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(auditProcessorEnablerRecordType) is true.
  
  Parameters:
  
  auditProcessorEnablerRecordType - the type of audit processor enabler record to retrieve
  
  Returns:
  
  the audit processor enabler record
  
  Throws:
  
  NullArgumentException - auditProcessorEnablerRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(auditProcessorEnablerRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.