Interface PoolEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface PoolEnabler
extends OsidEnabler

A PoolEnabler manages the active status of a Pool.

Method Summary

Modifier and Type	Method	Description
PoolEnablerRecord	getPoolEnablerRecord(Type poolEnablerRecordType)	Gets the pool enabler record corresponding to the given PoolEnabler record Type .

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface Operable

isActive, isDisabled, isEnabled, isOperational

Modifier and Type	Method	Description
boolean	isActive()	Tests if this operable is active.
boolean	isDisabled()	Tests if this operable is administravely disabled.
boolean	isEnabled()	Tests if this operable is administravely enabled.
boolean	isOperational()	Tests if this Operable is operational.

Methods inherited from interface OsidEnabler

getCyclicEvent, getCyclicEventId, getCyclicTimePeriod, getCyclicTimePeriodId, getEvent, getEventId, getSchedule, getScheduleId, getTimePeriod, getTimePeriodId, isOperationalDuringCyclicEvent, isOperationalDuringCyclicTimePeriod, isOperationalDuringEvent, isOperationalDuringTimePeriod, isOperationalOnSchedule, isRequirement

Modifier and Type	Method	Description
CyclicEvent	getCyclicEvent()	Gets the cyclic event.
Id	getCyclicEventId()	Gets the cyclic event Id .
CyclicTimePeriod	getCyclicTimePeriod()	Gets the cyclic time period.
Id	getCyclicTimePeriodId()	Gets the cyclic time period Id .
Event	getEvent()	Gets the event.
Id	getEventId()	Gets the event Id .
Schedule	getSchedule()	Gets the schedule.
Id	getScheduleId()	Gets the schedule Id .
TimePeriod	getTimePeriod()	Gets the time period.
Id	getTimePeriodId()	Gets the time period Id .
boolean	isOperationalDuringCyclicEvent()	Tests if the operational status of the enabler is governed by a CyclicEvent .
boolean	isOperationalDuringCyclicTimePeriod()	Tests if this enabler is applied to a recurring CyclicTimePeriod .
boolean	isOperationalDuringEvent()	Tests if the operational status of the enabler is governed by an Event .
boolean	isOperationalDuringTimePeriod()	Tests if this enabler is applied to a TimePeriod .
boolean	isOperationalOnSchedule()	Tests if the operational status of the enabler is governed by a Schedule .
boolean	isRequirement()	Tests if this OsidEnabler is a requirement.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Methods inherited from interface OsidRule

getConditionRecordTypes, getRule, getRuleId, hasRule

Modifier and Type	Method	Description
TypeList	getConditionRecordTypes()	Gets the list of OsidCondition OsidRecord Types this rule requires.
Rule	getRule()	Gets the explicit rule.
Id	getRuleId()	Gets the explicit rule Id .
boolean	hasRule()	Tests if an explicit rule is available.

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

getPoolEnablerRecord

PoolEnablerRecord getPoolEnablerRecord(Type poolEnablerRecordType)
                                throws OperationFailedException

Gets the pool enabler record corresponding to the given PoolEnabler record Type . This method ie used to retrieve an object implementing the requested record. The poolEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(poolEnablerRecordType) is true.

Parameters:

poolEnablerRecordType - the type of pool enabler record to retrieve

Returns:

the pool enabler record

Throws:

NullArgumentException - poolEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.