public interface CompositionEnablerRepositoryAssignmentSession extends OsidSession
This session provides methods to re-assign CompositionEnabler
to Repository
mappings. A CompositionEnabler
may appear in multiple Repository
objects and
removing the last reference to a CompositionEnabler
is the
equivalent of deleting it. Each Composition
may have its
own authorizations governing who is allowed to operate on it.
Adding a reference of a CompositionEnabler
to another
Repository
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignCompositionEnablerToRepository(Id compositionEnablerId,
Id repositoryId)
Adds an existing
CompositionEnabler to a
Repository. |
boolean |
canAssignCompositionEnablers()
Tests if this user can alter composition enabler/repository mappings.
|
boolean |
canAssignCompositionEnablersToRepository(Id repositoryId)
Tests if this user can alter composition enabler/repository mappings.
|
IdList |
getAssignableRepositoryIds(Id repositoryId)
Gets a list of repositories including and under the given repository
node in which any repository enabler can be assigned.
|
IdList |
getAssignableRepositoryIdsForCompositionEnabler(Id repositoryId,
Id compositionEnablerId)
Gets a list of repositories including and under the given repository
node in which a specific repository enabler can be assigned.
|
void |
reassignCompositionEnablerToRepository(Id compositionEnablerId,
Id fromRepositoryId,
Id toRepositoryId)
Moves a
CompositionEnabler from one Repository
to another. |
void |
unassignCompositionEnablerFromRepository(Id compositionEnablerId,
Id repositoryId)
Removes a
CompositionEnabler from a Repository. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignCompositionEnablers()
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 canAssignCompositionEnablersToRepository(Id repositoryId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.repositoryId
- the Id
of the Repository
false
if mapping is not authorized, true
otherwiseNullArgumentException
- repositoryId
is
null
mandatory
- This method must be implemented. IdList getAssignableRepositoryIds(Id repositoryId) throws OperationFailedException
repositoryId
- the Id
of the Repository
Ids
NullArgumentException
- repositoryId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableRepositoryIdsForCompositionEnabler(Id repositoryId, Id compositionEnablerId) throws OperationFailedException
repositoryId
- the Id
of the Repository
compositionEnablerId
- the Id
of the
CompositionEnabler
Ids
NullArgumentException
- repositoryId
or
compositionEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignCompositionEnablerToRepository(Id compositionEnablerId, Id repositoryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler
to a
Repository.
compositionEnablerId
- the Id
of the
CompositionEnabler
repositoryId
- the Id
of the Repository
AlreadyExistsException
- compositionEnablerId
is alraedy assigned to repositoryId
NotFoundException
- compositionEnablerId
or repositoryId
not foundNullArgumentException
- compositionEnablerId
or repositoryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCompositionEnablerFromRepository(Id compositionEnablerId, Id repositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler
from a Repository.
compositionEnablerId
- the Id
of the
CompositionEnabler
repositoryId
- the Id
of the Repository
NotFoundException
- compositionEnablerId
or repositoryId
not found or
compositionEnablerId
not assigned to
repositoryId
NullArgumentException
- compositionEnablerId
or repositoryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignCompositionEnablerToRepository(Id compositionEnablerId, Id fromRepositoryId, Id toRepositoryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompositionEnabler
from one Repository
to another. Mappings to other Repositories
are
unaffected.compositionEnablerId
- the Id
of the
CompositionEnabler
fromRepositoryId
- the Id
of the current
Repository
toRepositoryId
- the Id
of the destination
Repository
NotFoundException
- compositionEnablerId,
fromRepositoryId,
or toRepositoryId
not
found or compositionEnablerId
not mapped to
fromRepositoryId
NullArgumentException
- compositionEnablerId,
fromRepositoryId,
or toRepositoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.