Interface StepProcessorEnablerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidEnablerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface StepProcessorEnablerSearchOrder
extends OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
StepProcessorEnablerSearchOrderRecord	getStepProcessorEnablerSearchOrderRecord(Type stepProcessorEnablerRecordType)	Gets the step processor enabler search order record corresponding to the given step processor enabler 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 OsidEnablerSearchOrder

getCyclicEventSearchOrder, getCyclicTimePeriodSearchOrder, getEventSearchOrder, getScheduleSearchOrder, getTimePeriodSearchOrder, orderByCyclicEvent, orderByCyclicTimePeriod, orderByEvent, orderByRequirement, orderBySchedule, orderByTimePeriod, supportsCyclicEventSearchOrder, supportsCyclicTimePeriodSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder, supportsTimePeriodSearchOrder

Modifier and Type	Method	Description
CyclicEventSearchOrder	getCyclicEventSearchOrder()	Gets the cyclic event search order.
CyclicTimePeriodSearchOrder	getCyclicTimePeriodSearchOrder()	Gets the cyclic time period search order.
EventSearchOrder	getEventSearchOrder()	Gets the search order for an event.
ScheduleSearchOrder	getScheduleSearchOrder()	Gets the search order for a schedule.
TimePeriodSearchOrder	getTimePeriodSearchOrder()	Gets the time period search order.
void	orderByCyclicEvent(SearchOrderStyle style)	Orders the results by cyclic event.
void	orderByCyclicTimePeriod(SearchOrderStyle style)	Orders the results by cyclic time period.
void	orderByEvent(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated event.
void	orderByRequirement(SearchOrderStyle style)	Specifies a preference for ordering the results by the requirement flag.
void	orderBySchedule(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated schedule.
void	orderByTimePeriod(SearchOrderStyle style)	Orders the results by time period.
boolean	supportsCyclicEventSearchOrder()	Tests if a cyclic event search order is available.
boolean	supportsCyclicTimePeriodSearchOrder()	Tests if a cyclic time period search order is available.
boolean	supportsEventSearchOrder()	Tests if an EventSearchOrder is available.
boolean	supportsScheduleSearchOrder()	Tests if a ScheduleSearchOrder is available.
boolean	supportsTimePeriodSearchOrder()	Tests if a time period search order is available.

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id.

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book.
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process.
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter.

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

Methods inherited from interface OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Modifier and Type	Method	Description
RuleSearchOrder	getRuleSearchOrder()	Gets the search order for a rule.
void	orderByRule(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated rule.
boolean	supportsRuleSearchOrder()	Tests if a RuleSearchOrder is available.

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

getStepProcessorEnablerSearchOrderRecord

StepProcessorEnablerSearchOrderRecord getStepProcessorEnablerSearchOrderRecord(Type stepProcessorEnablerRecordType)
                                                                        throws OperationFailedException

Gets the step processor enabler search order record corresponding to the given step processor enabler record Type. Multiple retrievals return the same underlying object.

Parameters:

stepProcessorEnablerRecordType - a step processor enabler record type

Returns:

the step processor enabler search order record

Throws:

NullArgumentException - stepProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.