org.osid.profile

Interface ProfileEntrySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface ProfileEntrySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getAgentSearchOrder() Gets the agent search order.
ProfileEntrySearchOrderRecord	getProfileEntrySearchOrderRecord(Type profileEntryRecordType) Gets the profile entry search order record corresponding to the given profile entry record Type.
ProfileItemSearchOrder	getProfileItemSearchOrder() Gets the profil eitem search order.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the agent.
void	orderByImplicit(SearchOrderStyle style) Specifies a preference for ordering the result set by the implicit status.
void	orderByProfileItem(SearchOrderStyle style) Specifies a preference for ordering the result set by the active status.
void	orderByResource(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
boolean	supportsAgentSearchOrder() Tests if an Agent is available.
boolean	supportsProfileItemSearchOrder() Tests if a ProfileItem is available.
boolean	supportsResourceSearchOrder() Tests if a Resource is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

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

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByImplicit

void orderByImplicit(SearchOrderStyle style)

Specifies a preference for ordering the result set by the implicit status.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByResource

void orderByResource(SearchOrderStyle style)

Specifies a preference for ordering the result set by the resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a Resource is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsResourceSearchOrder() is true.

orderByAgent

void orderByAgent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAgentSearchOrder

boolean supportsAgentSearchOrder()

Tests if an Agent is available.

Returns:

true if an agent search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentSearchOrder

AgentSearchOrder getAgentSearchOrder()

Gets the agent search order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsAgentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAgentSearchOrder() is true.

orderByProfileItem

void orderByProfileItem(SearchOrderStyle style)

Specifies a preference for ordering the result set by the active status.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProfileItemSearchOrder

boolean supportsProfileItemSearchOrder()

Tests if a ProfileItem is available.

Returns:

true if a profile item search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProfileItemSearchOrder

ProfileItemSearchOrder getProfileItemSearchOrder()

Gets the profil eitem search order.

Returns:

the profile item search order

Throws:

UnimplementedException - supportsProfileItemSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsProfileItemSearchOrder() is true.

getProfileEntrySearchOrderRecord

ProfileEntrySearchOrderRecord getProfileEntrySearchOrderRecord(Type profileEntryRecordType)
                                                               throws OperationFailedException

Gets the profile entry search order record corresponding to the given profile entry record Type. Multiple retrievals return the same underlying object.

Parameters:

profileEntryRecordType - a profile entry record type

Returns:

the profile entry search order record

Throws:

NullArgumentException - profileEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.