public interface AvailabilityEnablerFoundryAssignmentSession extends OsidSession
This session provides methods to re-assign AvailabilityEnabler
to Foundry
mappings. an AvailabilityEnabler
may appear in multiple Foundry
objects and removing
the last reference to an AvailabilityEnabler
is the
equivalent of deleting it. Each Foundry
may have its own
authorizations governing who is allowed to operate on it.
Adding a reference of an AvailabilityEnabler
to another
Foundry
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAvailabilityEnablerToFoundry(Id availabilityEnablerId,
Id foundryId)
Adds an existing
AvailabilityEnabler to a
Foundry. |
boolean |
canAssignAvailabilityEnablers()
Tests if this user can alter availability enabler/foundry mappings.
|
boolean |
canAssignAvailabilityEnablersToFoundry(Id foundryId)
Tests if this user can alter availability enabler/foundry mappings.
|
IdList |
getAssignableFoundryIds(Id foundryId)
Gets a list of foundries including and under the given foundry node in
which any availability enabler can be assigned.
|
IdList |
getAssignableFoundryIdsForAvailabilityEnabler(Id foundryId,
Id availabilityEnablerId)
Gets a list of foundries including and under the given foundry node in
which a specific availability enabler can be assigned.
|
void |
unassignAvailabilityEnablerFromFoundry(Id availabilityEnablerId,
Id foundryId)
Removes an
AvailabilityEnabler from a Foundry. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAvailabilityEnablers()
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 canAssignAvailabilityEnablersToFoundry(Id foundryId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.foundryId
- the Id
of the Foundry
false
if mapping is not authorized, true
otherwiseNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. IdList getAssignableFoundryIds(Id foundryId) throws OperationFailedException
foundryId
- the Id
of the Foundry
Ids
NullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableFoundryIdsForAvailabilityEnabler(Id foundryId, Id availabilityEnablerId) throws OperationFailedException
foundryId
- the Id
of the Foundry
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
Ids
NullArgumentException
- foundryId
or
availabilityEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAvailabilityEnablerToFoundry(Id availabilityEnablerId, Id foundryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler
to a
Foundry.
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
foundryId
- the Id
of the Foundry
AlreadyExistsException
- availabilityEnablerId
is already assigned to foundryId
NotFoundException
- availabilityEnablerId
or foundryId
not foundNullArgumentException
- availabilityEnablerId
or foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAvailabilityEnablerFromFoundry(Id availabilityEnablerId, Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler
from a Foundry.
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
foundryId
- the Id
of the Foundry
NotFoundException
- availabilityEnablerId
or foundryId
not found or
availabilityEnablerId
not assigned to foundryId
NullArgumentException
- availabilityEnablerId
or foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.