public interface ProfileEntryEnablerAdminSession extends OsidSession
This session creates and removes profile entry enablers. The data for
create and update is provided via the ProfileEntryEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasProfileEntryEnabler(Id profileEntryEnablerId,
Id aliasId)
Adds an
Id to a ProfileEntryEnabler for
the purpose of creating compatibility. |
boolean |
canCreateProfileEntryEnabler()
Tests if this user can create profile entry enablers.
|
boolean |
canCreateProfileEntryEnablerWithRecordTypes(Type[] profileEntryEnablerRecordTypes)
Tests if this user can create a single
ProfileEntryEnabler
using the desired record types. |
boolean |
canDeleteProfileEntryEnablers()
Tests if this user can delete profile entry enablers.
|
boolean |
canManageProfileEntryEnablerAliases()
Tests if this user can manage
Id aliases for profile
entry enablers. |
boolean |
canUpdateProfileEntryEnablers()
Tests if this user can update profile entry enablers.
|
ProfileEntryEnabler |
createProfileEntryEnabler(ProfileEntryEnablerForm profileEntryEnablerForm)
Creates a new
ProfileEntryEnabler. |
void |
deleteProfileEntryEnabler(Id profileEntryEnablerId)
Deletes a
ProfileEntryEnabler. |
Profile |
getProfile()
Gets the
Profile associated with this session. |
ProfileEntryEnablerForm |
getProfileEntryEnablerFormForCreate(Type[] profileEntryEnablerRecordTypes)
Gets the profile entry enabler form for creating new profile entry
enablers.
|
ProfileEntryEnablerForm |
getProfileEntryEnablerFormForUpdate(Id profileEntryEnablerId)
Gets the profile entry enabler form for updating an existing profile
entry enabler.
|
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
void |
updateProfileEntryEnabler(ProfileEntryEnablerForm profileEntryEnablerForm)
Updates an existing profile entry enabler.
|
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 canCreateProfileEntryEnabler()
ProfileEntryEnabler
will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer create
operations to an unauthorized user. false
if ProfileEntryEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateProfileEntryEnablerWithRecordTypes(Type[] profileEntryEnablerRecordTypes)
ProfileEntryEnabler
using the desired record types. While
ProfileRulesManager.getProfileEntryEnablerRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific
ProfileEntryEnabler.
Providing an empty array tests if a
ProfileEntryEnabler
can be created with no records.profileEntryEnablerRecordTypes
- array of profile entry enabler
types true
if ProfileEntryEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
profileEntryEnablerRecordTypes
is null
mandatory
- This method must be implemented. ProfileEntryEnablerForm getProfileEntryEnablerFormForCreate(Type[] profileEntryEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
profileEntryEnablerRecordTypes
- array of profile entry enabler
typesNullArgumentException
-
profileEntryEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unabel to get form for requested
record typesmandatory
- This method must be implemented. ProfileEntryEnabler createProfileEntryEnabler(ProfileEntryEnablerForm profileEntryEnablerForm) throws OperationFailedException, PermissionDeniedException
ProfileEntryEnabler.
profileEntryEnablerForm
- the form for this
ProfileEntryEnabler
ProfileEntryEnabler
IllegalStateException
- profileEntryEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- profileEntryEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- profileEntryEnablerForm
did not originate from
getProfileEntryEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateProfileEntryEnablers()
ProfileEntryEnabler
will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer update
operations to an unauthorized user. false
if ProfileEntryEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. ProfileEntryEnablerForm getProfileEntryEnablerFormForUpdate(Id profileEntryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
NotFoundException
- profileEntryEnablerId
is not foundNullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateProfileEntryEnabler(ProfileEntryEnablerForm profileEntryEnablerForm) throws OperationFailedException, PermissionDeniedException
profileEntryEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- profileEntryEnablerForm
already used in an upate transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- profileEntryEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- profileEntryEnablerForm
did not originate from
getProfileEntryEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteProfileEntryEnablers()
ProfileEntryEnabler
will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer delete
operations to an unauthorized user. false
if ProfileEntryEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteProfileEntryEnabler(Id profileEntryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntryEnabler.
profileEntryEnablerId
- the Id
of the
ProfileEntryEnabler
to removeNotFoundException
- profileEntryEnablerId
not foundNullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageProfileEntryEnablerAliases()
Id
aliases for profile
entry enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if ProfileEntryEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasProfileEntryEnabler(Id profileEntryEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a ProfileEntryEnabler
for
the purpose of creating compatibility. The primary Id
of the ProfileEntryEnabler
is determined by the
provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another
profile entry enabler. it is reassigned to the given profile entry
enabler Id.
profileEntryEnablerId
- the Id
of a
ProfileEntryEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- profileEntryEnablerId
not foundNullArgumentException
- profileEntryEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.