public interface ProfileEntryEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply ProfileEntryEnablers
to ProfileEntries.
A ProfileEntry
with multiple ProfileEntryEnablers
means any positive rule
evaluation across the enablers result in an effective ProfileEntry.
Modifier and Type | Method and Description |
---|---|
void |
assignProfileEntryEnablerToProfileEntry(Id profileEntryEnablerId,
Id profileEntryId)
Adds an existing
ProfileEntryEnabler to a
ProfileEntry. |
boolean |
canAssignProfileEntryEnablers()
Tests if this user can alter profile entry enabler/profile entry
mappings.
|
boolean |
canAssignProfileEntryEnablerToProfileEntry(Id profileEntryId)
Tests if this user can alter profile entry enabler/profile entry
mappings.
|
boolean |
canSequenceProfileEntryEnablers()
Tests if this user can order
ProfileEntryEnablers. |
IdList |
getAssignableProfileEntryIdsForProfileEntryEnabler(Id profileEntryEnablerId)
Gets a list of profile entry in which a specific profile entry enabler
can be assigned.
|
Profile |
getProfile()
Gets the
Profile associated with this session. |
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
void |
moveProfileEntryEnablerAhead(Id profileEntryEnablerId,
Id profileEntryId,
Id referenceId)
Reorders profile entry enablers for a profile entry by moving the
specified profile entry enabler in front of a reference profile entry
enabler.
|
void |
moveProfileEntryEnablerBehind(Id profileEntryEnablerId,
Id profileEntryId,
Id referenceId)
Reorders profile entry enablers for a profile entry by moving the
specified profile entry enabler behind a reference profile entry
enabler.
|
void |
orderProfileEntryEnablers(Id[] profileEntryEnablerIds,
Id profileEntryId)
Reorders a set of profile entry enablers for a profile entry.
|
void |
unassignProfileEntryEnablerFromProfileEntry(Id profileEntryEnablerId,
Id profileEntryId)
Removes a
ProfileEntryEnabler from a
ProfileEntry. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProfileId()
Profile
Id
associated with this
session. Profile Id
associated with this sessionmandatory
- This method must be implemented. Profile getProfile() throws OperationFailedException, PermissionDeniedException
Profile
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignProfileEntryEnablers()
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. boolean canAssignProfileEntryEnablerToProfileEntry(Id profileEntryId)
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users.profileEntryId
- the Id
of the
ProfileEntry
false
if mapping is not authorized, true
otherwiseNullArgumentException
- profileEntryId
is null
mandatory
- This method must be implemented. IdList getAssignableProfileEntryIdsForProfileEntryEnabler(Id profileEntryEnablerId) throws OperationFailedException
profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
Ids
NullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignProfileEntryEnablerToProfileEntry(Id profileEntryEnablerId, Id profileEntryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntryEnabler
to a
ProfileEntry.
profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
profileEntryId
- the Id
of the
ProfileEntry
AlreadyExistsException
- profileEntryEnablerId
is already applied to profileEntryId
NotFoundException
- profileEntryEnablerId
or profileEntryId
not foundNullArgumentException
- profileEntryEnablerId
or profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignProfileEntryEnablerFromProfileEntry(Id profileEntryEnablerId, Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntryEnabler
from a
ProfileEntry.
profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
profileEntryId
- the Id
of the
ProfileEntry
NotFoundException
- profileEntryEnablerId
or profileEntryId
not found or
profileEntryEnablerId not applied to profileEntryId
NullArgumentException
- profileEntryEnablerId
or profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceProfileEntryEnablers()
ProfileEntryEnablers.
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 ProfileEntryEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveProfileEntryEnablerAhead(Id profileEntryEnablerId, Id profileEntryId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileEntryEnablerId
- the Id
of a
ProfileEntryEnabler
profileEntryId
- the Id
of a ProfileEntry
referenceId
- the reference profile entry enabler Id
NotFoundException
- profileEntryEnablerId,
profileEntryId,
or referenceId
not
found or, profileEntryEnablerId
or
referenceId
not related to profileEntryId
NullArgumentException
- profileEntryEnablerId,
profileEntryId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveProfileEntryEnablerBehind(Id profileEntryEnablerId, Id profileEntryId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileEntryEnablerId
- the Id
of a
ProfileEntryEnabler
profileEntryId
- the Id
of a ProfileEntry
referenceId
- the reference profile entry enabler Id
NotFoundException
- profileEntryEnablerId,
profileEntryId,
or referenceId
not
found or, profileEntryEnablerId
or
referenceId
not related to profileEntryId
NullArgumentException
- profileEntryEnablerId,
profileEntryId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderProfileEntryEnablers(Id[] profileEntryEnablerIds, Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileEntryEnablerIds
- the Ids
for a set of
ProfileEntryEnablers
profileEntryId
- the Id
of a ProfileEntry
NotFoundException
- profileEntryId
not
found or, an profileEntryEnablerId
not related
to profileEntryId
NullArgumentException
- profileEntryEnablerIds
or profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.