AuditEnabler

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

public interface AuditEnabler extends OsidEnabler

An AuditEnabler describes the rules for making an Audit effective.

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

Method Summary

Modifier and Type

Method

Description

AuditEnablerRecord

getAuditEnablerRecord(Type auditEnablerRecordType)

Gets the audit enabler record corresponding to the given AuditEnabler 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
- getAuditEnablerRecord
  
  AuditEnablerRecord getAuditEnablerRecord(Type auditEnablerRecordType) throws OperationFailedException
  
  Gets the audit enabler record corresponding to the given AuditEnabler record Type. This method is used to retrieve an object implementing the requested record. The inquiryEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(inquiryEnablerRecordType) is true.
  
  Parameters:
  
  auditEnablerRecordType - the type of audit enabler record to retrieve
  
  Returns:
  
  the audit enabler record
  
  Throws:
  
  NullArgumentException - auditEnablerRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(auditEnablerRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.