IssueProcessorEnabler

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

public interface IssueProcessorEnabler extends OsidEnabler

An IssueProcessorEnabler manages the active status of an IssueProcessor..

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

Method Summary

Modifier and Type

Method

Description

IssueProcessorEnablerRecord

getIssueProcessorEnablerRecord(Type issueProcessorEnablerRecordType)

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