Interface RelevancyEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RelevancyEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply RelevancyEnablers to Relevancies . A Relevancy with multiple RelevancyEnablers means any positive rule evaluation across the enablers result in an effective Relevancy .

Method Summary

Modifier and Type	Method	Description
void	assignRelevancyEnablerToRelevancy(Id relevancyEnablerId, Id relevancyId)	Adds an existing RelevancyEnabler to a Relevancy .
boolean	canAssignRelevancyEnablers()	Tests if this user can alter relevancy enabler/relevancy mappings.
boolean	canSequenceRelevancyEnablers()	Tests if this user can order RelevancyEnablers .
Ontology	getOntology()	Gets the Ontology associated with this session.
Id	getOntologyId()	Gets the Ontology Id associated with this session.
void	moveRelevancyEnablerAhead(Id relevancyEnablerId, Id relevancyId, Id referenceId)	Reorders relevancy enablers for a relevancy by moving the specified relevancy enabler in front of a reference relevancy enabler.
void	moveRelevancyEnablerBehind(Id relevancyEnablerId, Id relevancyId, Id referenceId)	Reorders relevancy enablers for a relevancy by moving the specified relevancy enabler behind a reference relevancy enabler.
void	orderRelevancyEnablers(Id[] relevancyEnablerIds, Id relevancyId)	Reorders a set of relevancy enablers for a relevancy.
void	unassignRelevancyEnablerFromRelevancy(Id relevancyEnablerId, Id relevancyId)	Removes a RelevancyEnabler from a Relevancy .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getOntologyId

Id getOntologyId()

Gets the Ontology Id associated with this session.

Returns:

the Ontology Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOntology

Ontology getOntology()
              throws OperationFailedException,
PermissionDeniedException

Gets the Ontology associated with this session.

Returns:

the ontology

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignRelevancyEnablers

boolean canAssignRelevancyEnablers()

Tests if this user can alter relevancy enabler/relevancy mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignRelevancyEnablerToRelevancy

void assignRelevancyEnablerToRelevancy(Id relevancyEnablerId,
 Id relevancyId)
                                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing RelevancyEnabler to a Relevancy .

Parameters:

relevancyEnablerId - the Id of the RelevancyEnabler

relevancyId - the Id of the Relevancy

Throws:

AlreadyExistsException - relevancyEnablerId is already applied to relevancyId

NotFoundException - relevancyEnablerId or relevancyId not found

NullArgumentException - relevancyEnablerId or relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRelevancyEnablerFromRelevancy

void unassignRelevancyEnablerFromRelevancy(Id relevancyEnablerId,
 Id relevancyId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a RelevancyEnabler from a Relevancy .

Parameters:

relevancyEnablerId - the Id of the RelevancyEnabler

relevancyId - the Id of the Relevancy

Throws:

NotFoundException - relevancyEnablerId or relevancyId not found or relevancyEnablerId not applied to relevancyId

NullArgumentException - relevancyEnablerId or relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceRelevancyEnablers

boolean canSequenceRelevancyEnablers()

Tests if this user can order RelevancyEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if RelevancyEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveRelevancyEnablerAhead

void moveRelevancyEnablerAhead(Id relevancyEnablerId,
 Id relevancyId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders relevancy enablers for a relevancy by moving the specified relevancy enabler in front of a reference relevancy enabler.

Parameters:

relevancyEnablerId - the Id of a RelevancyEnabler

relevancyId - the Id of a Relevancy

referenceId - the reference relevancy enabler Id

Throws:

NotFoundException - relevancyEnablerId, relevancyId , or referenceId not found or, relevancyEnablerId or referenceId not related to relevancyId

NullArgumentException - relevancyEnablerId, relevancyId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveRelevancyEnablerBehind

void moveRelevancyEnablerBehind(Id relevancyEnablerId,
 Id relevancyId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders relevancy enablers for a relevancy by moving the specified relevancy enabler behind a reference relevancy enabler.

Parameters:

relevancyEnablerId - the Id of a RelevancyEnabler

relevancyId - the Id of a Relevancy

referenceId - the reference relevancy enabler Id

Throws:

NotFoundException - relevancyEnablerId, relevancyId , or referenceId not found or, relevancyEnablerId or referenceId not related to relevancyId

NullArgumentException - relevancyEnablerId, relevancyId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderRelevancyEnablers

void orderRelevancyEnablers(Id[] relevancyEnablerIds,
 Id relevancyId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of relevancy enablers for a relevancy.

Parameters:

relevancyEnablerIds - the Ids for a set of RelevancyEnablers

relevancyId - the Id of a Relevancy

Throws:

NotFoundException - relevancyId not found or, a relevancyEnablerId not related to relevancyId

NullArgumentException - relevancyEnablerIds or relevancyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.