org.osid.cataloging.rules

Interface CatalogEnabler

All Superinterfaces:

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

public interface CatalogEnabler
extends OsidEnabler

A CatalogEnabler describes the rules for enabling the Catalog in a federated hierarchy.

Method Summary

Methods

Modifier and Type	Method and Description
CatalogEnablerRecord	getCatalogEnablerRecord(Type catalogEnablerRecordType) Gets the catalog enabler record corresponding to the given CatalogEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getCatalogEnablerRecord

CatalogEnablerRecord getCatalogEnablerRecord(Type catalogEnablerRecordType)
                                             throws OperationFailedException

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

Parameters:

catalogEnablerRecordType - the type of catalog enabler record to retrieve

Returns:

the catalog enabler record

Throws:

NullArgumentException - catalogEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.