org.osid.personnel

Interface PositionSearchOrder

All Superinterfaces:

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

public interface PositionSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
GradeSearchOrder	getLevelSearchOrder() Gets the level search order.
OrganizationSearchOrder	getOrganizationSearchOrder() Gets the organization search order.
PositionSearchOrderRecord	getPositionSearchOrderRecord(Type positionRecordType) Gets the position search order record corresponding to the given position record Type.
void	orderByBenefitsType(SearchOrderStyle style) Specifies a preference for ordering the result set by the benefits type.
void	orderByCompensationFrequency(SearchOrderStyle style) Specifies a preference for ordering the result set by the compensation frequency.
void	orderByExempt(SearchOrderStyle style) Specifies a preference for ordering the result set by the exempt flag.
void	orderByHighSalaryRange(SearchOrderStyle style) Specifies a preference for ordering the result set by the high salary.
void	orderByLevel(SearchOrderStyle style) Specifies a preference for ordering the result set by the level.
void	orderByLowSalaryRange(SearchOrderStyle style) Specifies a preference for ordering the result set by the low salary.
void	orderByMidpointSalaryRange(SearchOrderStyle style) Specifies a preference for ordering the result set by the midpoint salary.
void	orderByOrganization(SearchOrderStyle style) Specifies a preference for ordering the result set by the organization.
void	orderByRequiredCommitment(SearchOrderStyle style) Specifies a preference for ordering the result set by the required commitment.
void	orderByTargetAppointments(SearchOrderStyle style) Specifies a preference for ordering the result set by the target appointments.
void	orderByTitle(SearchOrderStyle style) Specifies a preference for ordering the result set by the title.
boolean	supportsLevelSearchOrder() Tests if a grade level search order is available.
boolean	supportsOrganizationSearchOrder() Tests if a organization search order is available.

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

orderByOrganization

void orderByOrganization(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOrganizationSearchOrder

boolean supportsOrganizationSearchOrder()

Tests if a organization search order is available.

Returns:

true if a organization search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchOrder

OrganizationSearchOrder getOrganizationSearchOrder()

Gets the organization search order.

Returns:

the organization search order

Throws:

UnimplementedException - supportsOrganizationSearchOrder() is false

Compliance:

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

orderByTitle

void orderByTitle(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLevel

void orderByLevel(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsLevelSearchOrder

boolean supportsLevelSearchOrder()

Tests if a grade level search order is available.

Returns:

true if a level search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLevelSearchOrder

GradeSearchOrder getLevelSearchOrder()

Gets the level search order.

Returns:

the level search order

Throws:

UnimplementedException - supportsLevelSearchOrder() is false

Compliance:

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

orderByTargetAppointments

void orderByTargetAppointments(SearchOrderStyle style)

Specifies a preference for ordering the result set by the target appointments.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRequiredCommitment

void orderByRequiredCommitment(SearchOrderStyle style)

Specifies a preference for ordering the result set by the required commitment.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLowSalaryRange

void orderByLowSalaryRange(SearchOrderStyle style)

Specifies a preference for ordering the result set by the low salary.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMidpointSalaryRange

void orderByMidpointSalaryRange(SearchOrderStyle style)

Specifies a preference for ordering the result set by the midpoint salary.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByHighSalaryRange

void orderByHighSalaryRange(SearchOrderStyle style)

Specifies a preference for ordering the result set by the high salary.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCompensationFrequency

void orderByCompensationFrequency(SearchOrderStyle style)

Specifies a preference for ordering the result set by the compensation frequency.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByExempt

void orderByExempt(SearchOrderStyle style)

Specifies a preference for ordering the result set by the exempt flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBenefitsType

void orderByBenefitsType(SearchOrderStyle style)

Specifies a preference for ordering the result set by the benefits type.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getPositionSearchOrderRecord

PositionSearchOrderRecord getPositionSearchOrderRecord(Type positionRecordType)
                                                       throws OperationFailedException

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

Parameters:

positionRecordType - a position record type

Returns:

the position search order record

Throws:

NullArgumentException - positionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(positionRecordType) is false

Compliance:

mandatory - This method must be implemented.