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.
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOntologyId()
Ontology
Id
associated with
this session. Ontology Id
associated with this sessionmandatory
- This method must be implemented. Ontology getOntology() throws OperationFailedException, PermissionDeniedException
Ontology
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignRelevancyEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignRelevancyEnablerToRelevancy(Id relevancyEnablerId, Id relevancyId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RelevancyEnabler
to a
Relevancy.
relevancyEnablerId
- the Id
of the
RelevancyEnabler
relevancyId
- the Id
of the Relevancy
AlreadyExistsException
- relevancyEnablerId
is already applied to relevancyId
NotFoundException
- relevancyEnablerId
or relevancyId
not foundNullArgumentException
- relevancyEnablerId
or relevancyId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRelevancyEnablerFromRelevancy(Id relevancyEnablerId, Id relevancyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelevancyEnabler
from a Relevancy.
relevancyEnablerId
- the Id
of the
RelevancyEnabler
relevancyId
- the Id
of the Relevancy
NotFoundException
- relevancyEnablerId
or relevancyId
not found or
relevancyEnablerId
not applied to relevancyId
NullArgumentException
- relevancyEnablerId
or relevancyId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceRelevancyEnablers()
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. false
if RelevancyEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveRelevancyEnablerAhead(Id relevancyEnablerId, Id relevancyId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
relevancyEnablerId
- the Id
of a
RelevancyEnabler
relevancyId
- the Id
of a Relevancy
referenceId
- the reference relevancy enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveRelevancyEnablerBehind(Id relevancyEnablerId, Id relevancyId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
relevancyEnablerId
- the Id
of a
RelevancyEnabler
relevancyId
- the Id
of a Relevancy
referenceId
- the reference relevancy enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderRelevancyEnablers(Id[] relevancyEnablerIds, Id relevancyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
relevancyEnablerIds
- the Ids
for a set of
RelevancyEnablers
relevancyId
- the Id
of a Relevancy
NotFoundException
- relevancyId
not
found or, a relevancyEnablerId
not related to
relevancyId
NullArgumentException
- relevancyEnablerIds
or relevancyId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.