StepConstrainerSearchOrder

All Superinterfaces:: Extensible, OsidBrowsableSearchOrder, OsidConstrainerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface StepConstrainerSearchOrder extends OsidConstrainerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type

Method

Description

StepConstrainerSearchOrderRecord

getStepConstrainerSearchOrderRecord(Type stepConstrainerRecordType)

Gets the step constrainer search order record corresponding to the given step constrainer record Type.

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface OsidIdentifiableSearchOrder
orderById

Methods inherited from interface OsidObjectSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface OsidOperableSearchOrder
orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface OsidRuleSearchOrder
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Method Details
- getStepConstrainerSearchOrderRecord
  
  StepConstrainerSearchOrderRecord getStepConstrainerSearchOrderRecord(Type stepConstrainerRecordType) throws OperationFailedException
  
  Gets the step constrainer search order record corresponding to the given step constrainer record Type. Multiple retrievals return the same underlying object.
  
  Parameters:
  
  stepConstrainerRecordType - a step constrainer record type
  
  Returns:
  
  the step constrainer search order record
  
  Throws:
  
  NullArgumentException - stepConstrainerRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(stepConstrainerRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.