public interface RelationshipEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply RelationshipEnablers
to Relationships.
A Relationship
with multiple RelationshipEnablers
means any positive rule
evaluation across the enablers result in an effective Relationship.
Modifier and Type | Method and Description |
---|---|
void |
assignRelationshipEnablerToRelationship(Id relationshipEnablerId,
Id relationshipId)
Adds an existing
RelationshipEnabler to a
Relationship. |
boolean |
canAssignRelationshipEnablers()
Tests if this user can alter relationship enabler/relationship
mappings.
|
boolean |
canSequenceRelationshipEnablers()
Tests if this user can order
RelationshipEnablers. |
Family |
getFamily()
Gets the
Family associated with this session. |
Id |
getFamilyId()
Gets the
Family Id associated with this
session. |
void |
moveRelationshipEnablerAhead(Id relationshipEnablerId,
Id relationshipId,
Id referenceId)
Reorders relationship enablers for a relationship by moving the
specified relationship enabler in front of a reference relationship
enabler.
|
void |
moveRelationshipEnablerBehind(Id relationshipEnablerId,
Id relationshipId,
Id referenceId)
Reorders relationship enablers for a relationship by moving the
specified relationship enabler behind a reference relationship
enabler.
|
void |
orderRelationshipEnablers(Id[] relationshipEnablerIds,
Id relationshipId)
Reorders a set of relationship enablers for a relationship.
|
void |
unassignRelationshipEnablerFromRelationship(Id relationshipEnablerId,
Id relationshipId)
Removes a
RelationshipEnabler from a
Relationship. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFamilyId()
Family
Id
associated with this
session. Family Id
associated with this sessionmandatory
- This method must be implemented. Family getFamily() throws OperationFailedException, PermissionDeniedException
Family
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignRelationshipEnablers()
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 assignRelationshipEnablerToRelationship(Id relationshipEnablerId, Id relationshipId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnabler
to a
Relationship.
relationshipEnablerId
- the Id
of the
RelationshipEnabler
relationshipId
- the Id
of the
Relationship
AlreadyExistsException
- relationshipEnablerId
is already applied to relationshipId
NotFoundException
- relationshipEnablerId
or relationshipId
not foundNullArgumentException
- relationshipEnablerId
or relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRelationshipEnablerFromRelationship(Id relationshipEnablerId, Id relationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnabler
from a
Relationship.
relationshipEnablerId
- the Id
of the
RelationshipEnabler
relationshipId
- the Id
of the
Relationship
NotFoundException
- relationshipEnablerId
or relationshipId
not found or
relationshipEnablerId
not applied to
relationshipId
NullArgumentException
- relationshipEnablerId
or relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceRelationshipEnablers()
RelationshipEnablers.
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 RelationshipEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveRelationshipEnablerAhead(Id relationshipEnablerId, Id relationshipId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
relationshipEnablerId
- the Id
of a
RelationshipnEnabler
relationshipId
- the Id
of a Relationship
referenceId
- the reference relationship enabler Id
NotFoundException
- relationshipEnablerId,
relationshipId,
or referenceId
not
found or, relationshipnEnablerId
or
referenceId
not related to relationshipId
NullArgumentException
- relationshipEnablerId,
relationshipId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveRelationshipEnablerBehind(Id relationshipEnablerId, Id relationshipId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
relationshipEnablerId
- the Id
of a
RelationshipnEnabler
relationshipId
- the Id
of a Relationship
referenceId
- the reference relationship enabler Id
NotFoundException
- relationshipEnablerId,
relationshipId,
or referenceId
not
found or, relationshipnEnablerId
or
referenceId
not related to relationshipId
NullArgumentException
- relationshipEnablerId,
relationshipId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderRelationshipEnablers(Id[] relationshipEnablerIds, Id relationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
relationshipEnablerIds
- the Ids
for a set of
RelationshipnEnablers
relationshipId
- the Id
of a Relationship
NotFoundException
- relationshipId
not
found or, an relationshipEnablerId
not related
to relationshipId
NullArgumentException
- relationshipEnablerIds
or relationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.